/*
    * Copyright (c) 2020 bahlef.
    * All rights reserved. This program and the accompanying materials
    * are made available under the terms of the Eclipse Public License v2.0
    * which accompanies this distribution, and is available at
    * http://www.eclipse.org/legal/epl-v20.html
    * Contributors:
    * bahlef - initial API and implementation and/or initial documentation
    */
  package de.funfried.netbeans.plugins.external.formatter.java.palantir;
  
  import java.util.SortedSet;
  import java.util.prefs.Preferences;
  
  import javax.swing.text.BadLocationException;
  import javax.swing.text.Document;
  import javax.swing.text.StyledDocument;
  
  import org.apache.commons.lang3.tuple.Pair;
  import org.netbeans.api.annotations.common.CheckForNull;
  import org.netbeans.api.annotations.common.NonNull;
  import org.netbeans.api.editor.guards.GuardedSectionManager;
  import org.netbeans.api.project.Project;
  import org.openide.util.NbBundle;
  import org.openide.util.lookup.ServiceProvider;
  
  import com.palantir.javaformat.java.JavaFormatterOptions;
  
  import de.funfried.netbeans.plugins.external.formatter.FormatterService;
  import de.funfried.netbeans.plugins.external.formatter.MimeType;
  import de.funfried.netbeans.plugins.external.formatter.exceptions.FormattingFailedException;
  import de.funfried.netbeans.plugins.external.formatter.java.base.AbstractJavaFormatterService;
  import de.funfried.netbeans.plugins.external.formatter.java.palantir.ui.PalantirJavaFormatterOptionsPanel;
  import de.funfried.netbeans.plugins.external.formatter.ui.options.FormatterOptionsPanel;
  import de.funfried.netbeans.plugins.external.formatter.ui.options.Settings;
  
  /**
   * Palantir implementation of the {@link AbstractJavaFormatterService}.
   *
   * @author bahlef
   */
  @NbBundle.Messages({
  		"FormatterName=Palantir Java Code Formatter"
  })
  @ServiceProvider(service = FormatterService.class, position = 2000)
  public class PalantirJavaFormatterService extends AbstractJavaFormatterService<PalantirFormatJob> {
  	/** The ID of this formatter service. */
  	public static final String ID = "palantir-java-formatter";
  
  	/** * The {@link PalantirJavaFormatterWrapper} implementation. */
  	private final PalantirJavaFormatterWrapper formatter = new PalantirJavaFormatterWrapper();
  
  	/**
  	 * {@inheritDoc}
  	 */
  	@Override
  	public boolean canHandle(Document document) {
  		// Cannot handle guarded blocks properly due to a bug in the Google Java Code Formatter:
  		// https://github.com/google/google-java-format/issues/433
  		if (document instanceof StyledDocument) {
  			StyledDocument styledDoc = (StyledDocument) document;
  
  			if (GuardedSectionManager.getInstance(styledDoc) != null) {
  				return false;
  			}
  		}
  
  		return super.canHandle(document);
  	}
  
  	/**
  	 * {@inheritDoc}
  	 */
  	@NonNull
  	@Override
  	public String getDisplayName() {
  		return NbBundle.getMessage(PalantirJavaFormatterService.class, "FormatterName");
  	}
  
  	/**
  	 * {@inheritDoc}
  	 */
  	@NonNull
  	@Override
  	public String getId() {
  		return ID;
  	}
  
  	/**
  	 * {@inheritDoc}
  	 */
  	@Override
  	public FormatterOptionsPanel createOptionsPanel(Project project) {
  		return new PalantirJavaFormatterOptionsPanel(project);
  	}
  
  	/**
  	 * {@inheritDoc}
  	 */
 	@CheckForNull
 	@Override
 	public Integer getContinuationIndentSize(Document document) {
 		if (document == null) {
 			return null;
 		}
 
 		Integer ret = null;
 
 		Preferences preferences = Settings.getActivePreferences(document);
 		if (isUseFormatterIndentationSettings(preferences)) {
 			ret = 8;
 		}
 
 		return ret;
 	}
 
 	/**
 	 * {@inheritDoc}
 	 */
 	@CheckForNull
 	@Override
 	public Integer getIndentSize(Document document) {
 		if (document == null) {
 			return null;
 		}
 
 		Integer ret = null;
 
 		Preferences preferences = Settings.getActivePreferences(document);
 		if (isUseFormatterIndentationSettings(preferences)) {
 			ret = 4;
 		}
 
 		return ret;
 	}
 
 	/**
 	 * {@inheritDoc}
 	 */
 	@CheckForNull
 	@Override
 	public Integer getRightMargin(Document document) {
 		if (document == null) {
 			return null;
 		}
 
 		return JavaFormatterOptions.Style.PALANTIR.maxLineLength();
 	}
 
 	/**
 	 * {@inheritDoc}
 	 */
 	@Override
 	protected PalantirFormatJob getFormatJob(StyledDocument document, SortedSet<Pair<Integer, Integer>> changedElements) {
 		return new PalantirFormatJob(document, formatter, changedElements);
 	}
 
 	/**
 	 * {@inheritDoc}
 	 */
 	@CheckForNull
 	@Override
 	public Integer getSpacesPerTab(Document document) {
 		if (document == null) {
 			return null;
 		}
 
 		Integer ret = null;
 
 		Preferences preferences = Settings.getActivePreferences(document);
 		if (isUseFormatterIndentationSettings(preferences)) {
 			if (!isExpandTabToSpaces(document, preferences) && preferences.getBoolean(Settings.OVERRIDE_TAB_SIZE, true)) {
 				ret = preferences.getInt(Settings.OVERRIDE_TAB_SIZE_VALUE, 4);
 			} else {
 				ret = 4;
 			}
 		}
 
 		return ret;
 	}
 
 	/**
 	 * {@inheritDoc}
 	 */
 	@CheckForNull
 	@Override
 	public Boolean isExpandTabToSpaces(Document document) {
 		if (document == null) {
 			return null;
 		}
 
 		return isExpandTabToSpaces(document, Settings.getActivePreferences(document));
 	}
 
 	private Boolean isExpandTabToSpaces(Document document, Preferences preferences) {
 		if (document == null || preferences == null) {
 			return null;
 		}
 
 		Boolean ret = null;
 
 		if (isUseFormatterIndentationSettings(preferences)) {
 			ret = true;
 		}
 
 		return ret;
 	}
 
 	/**
 	 * Returns {@code true} if using the formatter indentation settings from the external
 	 * formatter is activated, otherwise {@code false}.
 	 *
 	 * @param prefs the {@link Preferences} where to check
 	 *
 	 * @return {@code true} if using the formatter indentation settings from the external
 	 *         formatter is activated, otherwise {@code false}
 	 */
 	private boolean isUseFormatterIndentationSettings(Preferences prefs) {
 		return prefs.getBoolean(Settings.ENABLE_USE_OF_INDENTATION_SETTINGS, true);
 	}
 
 	/**
 	 * {@inheritDoc}
 	 */
 	@Override
 	@CheckForNull
 	public Boolean organizeImports(StyledDocument document, boolean afterFixImports) throws BadLocationException {
 		if (!canHandle(document)) {
 			throw new FormattingFailedException("The file type '" + MimeType.getMimeTypeAsString(document) + "' is not supported");
 		}
 
 		getFormatJob(document, null).organizeImports();
 
 		return true;
 	}
 }