json/bundles/org.eclipse.wst.json.core/src/org/eclipse/wst/json/core/format/FormatProcessorJSON.java

/*******************************************************************************
 * Copyright (c) 2004, 2016 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Angelo Zerr <angelo.zerr@gmail.com> - copied from org.eclipse.wst.css.core.format.FormatProcessorCSS
 *                                           modified in order to process JSON Objects.
 *******************************************************************************/
package org.eclipse.wst.json.core.format;

import org.eclipse.jface.text.DocumentRewriteSession;
import org.eclipse.jface.text.DocumentRewriteSessionType;
import org.eclipse.jface.text.IDocumentExtension4;
import org.eclipse.jface.text.Region;
import org.eclipse.wst.json.core.document.IJSONDocument;
import org.eclipse.wst.json.core.document.IJSONModel;
import org.eclipse.wst.json.core.document.IJSONPair;
import org.eclipse.wst.json.core.internal.format.IJSONSourceFormatter;
import org.eclipse.wst.json.core.internal.format.JSONFormatUtil;
import org.eclipse.wst.json.core.internal.format.JSONSourceFormatterFactory;
import org.eclipse.wst.json.core.regions.JSONRegionContexts;
import org.eclipse.wst.sse.core.internal.format.AbstractStructuredFormatProcessor;
import org.eclipse.wst.sse.core.internal.format.IStructuredFormatPreferences;
import org.eclipse.wst.sse.core.internal.format.IStructuredFormatter;
import org.eclipse.wst.sse.core.internal.provisional.IStructuredModel;
import org.eclipse.wst.sse.core.internal.provisional.IndexedRegion;
import org.eclipse.wst.sse.core.internal.provisional.text.IStructuredDocumentRegion;
import org.w3c.dom.Node;

/**
 * Format processor for JSON.
 *
 */
public class FormatProcessorJSON extends AbstractStructuredFormatProcessor {
	/*
	 * Max length of text to be formatted to be considered a "small change" Used
	 * for document rewrite session type.
	 */
	private final int MAX_SMALL_FORMAT_SIZE = 1000;

	@Override
	protected String getFileExtension() {
		return "json"; //$NON-NLS-1$
	}

	@Override
	public void formatModel(IStructuredModel structuredModel, int start,
			int length) {
		JSONFormatUtil formatUtil = JSONFormatUtil.getInstance();
		if (structuredModel instanceof IJSONModel) {
			// BUG102822 take advantage of IDocumentExtension4
			IDocumentExtension4 docExt4 = null;
			if (structuredModel.getStructuredDocument() instanceof IDocumentExtension4) {
				docExt4 = (IDocumentExtension4) structuredModel
						.getStructuredDocument();
			}
			DocumentRewriteSession rewriteSession = null;

			try {
				DocumentRewriteSessionType rewriteType = (length > MAX_SMALL_FORMAT_SIZE) ? DocumentRewriteSessionType.UNRESTRICTED
						: DocumentRewriteSessionType.UNRESTRICTED_SMALL;
				rewriteSession = (docExt4 == null || docExt4
						.getActiveRewriteSession() != null) ? null : docExt4
						.startRewriteSession(rewriteType);

				IJSONDocument doc = ((IJSONModel) structuredModel)
						.getDocument();
				IndexedRegion startRegion = ((IJSONModel) structuredModel).getIndexedRegion(start);
				IndexedRegion endRegion = ((IJSONModel) structuredModel).getIndexedRegion(start + length);
				if (startRegion != null && endRegion != null) {
					start = startRegion.getStartOffset();
					int offset;
					if (endRegion instanceof IJSONPair) {
						offset = endRegion.getEndOffset();
						IStructuredDocumentRegion nextRegion = structuredModel.getStructuredDocument()
								.getRegionAtCharacterOffset(offset + 1);
						if (nextRegion.getType() == JSONRegionContexts.JSON_COMMA) {
							offset = nextRegion.getEndOffset();
						}
					} else {
						offset = endRegion.getEndOffset();
					}
					int end = offset - start;
					IJSONSourceFormatter formatter = JSONSourceFormatterFactory
							.getInstance().getSourceFormatter(
									doc);
					StringBuilder buf = formatter.format(doc, new Region(start, end));
					if (buf != null) {
						formatUtil.replaceSource(doc.getModel(), start, end, buf.toString());
					}
				}
			} finally {
				// BUG102822 take advantage of IDocumentExtension4
				if (docExt4 != null && rewriteSession != null)
					docExt4.stopRewriteSession(rewriteSession);
			}
		}
	}

	public IStructuredFormatPreferences getFormatPreferences() {
		return null;
	}

	@Override
	protected IStructuredFormatter getFormatter(Node node) {
		return null;
	}

	@Override
	protected void refreshFormatPreferences() {
	}
}