bundles/org.eclipse.wst.sse.core/src/org/eclipse/wst/sse/core/document/StructuredDocumentLoader.java

/*******************************************************************************
 * Copyright (c) 2001, 2004 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Jens Lukowski/Innoopract - initial renaming/restructuring
 *     
 *******************************************************************************/

package org.eclipse.wst.sse.core.document;

import java.io.File;
import java.io.IOException;
import java.io.Reader;
import java.nio.charset.MalformedInputException;

import org.eclipse.core.filebuffers.FileBuffers;
import org.eclipse.core.filebuffers.ITextFileBuffer;
import org.eclipse.core.filebuffers.ITextFileBufferManager;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.QualifiedName;
import org.eclipse.core.runtime.content.IContentDescription;
import org.eclipse.jface.text.IDocument;
import org.eclipse.wst.common.encoding.CodedIO;
import org.eclipse.wst.common.encoding.EncodingMemento;
import org.eclipse.wst.common.encoding.IContentDescriptionExtended;
import org.eclipse.wst.common.encoding.exceptions.MalformedInputExceptionWithDetail;


public class StructuredDocumentLoader {

	private ITextFileBufferManager fBufferManager;

	/**
	 * @see org.eclipse.wst.sse.core.document.IDocumentLoader#createNewStructuredDocument(org.eclipse.core.resources.IFile)
	 * @deprecated - use form with progress monitor
	 */
	public IEncodedDocument createNewStructuredDocument(IFile iFile) throws IOException, CoreException {
		return createNewStructuredDocument(iFile, null);
	}

	public IEncodedDocument createNewStructuredDocument(IFile iFile, IProgressMonitor monitor) throws IOException, CoreException {
		IDocument document = null;
		IPath locationPath = iFile.getFullPath();

		if (iFile.exists()) {

			getBufferManager().connect(locationPath, monitor);
			ITextFileBuffer buffer = getBufferManager().getTextFileBuffer(locationPath);
			document = buffer.getDocument();
		} else {
			document = getBufferManager().createEmptyDocument(locationPath);
		}

		return (IEncodedDocument) document;
	}

	public IEncodedDocument createNewStructuredDocument(IPath locationPath, IProgressMonitor monitor) throws IOException, CoreException {
		IDocument document = null;
		File file = null;
		file = FileBuffers.getSystemFileAtLocation(locationPath);
		if (file.exists()) {
			getBufferManager().connect(locationPath, monitor);
			ITextFileBuffer buffer = getBufferManager().getTextFileBuffer(locationPath);
			document = buffer.getDocument();
		} else {
			document = getBufferManager().createEmptyDocument(locationPath);
		}
		return (IEncodedDocument) document;
	}

	/**
	 * @return
	 */
	protected ITextFileBufferManager getBufferManager() {
		if (fBufferManager == null) {
			fBufferManager = FileBuffers.getTextFileBufferManager();
		}
		return fBufferManager;
	}

	private String getCharset(Reader reader) throws IOException {
		String result = null;
		IContentDescription description = Platform.getContentTypeManager().getDescriptionFor(reader, null, new QualifiedName[]{IContentDescription.CHARSET, IContentDescriptionExtended.DETECTED_CHARSET});
		String javaCharset = (String) description.getProperty(IContentDescription.CHARSET);
		String detectedCharset = (String) description.getProperty(IContentDescriptionExtended.DETECTED_CHARSET);
		EncodingMemento encodingMemento = (EncodingMemento) description.getProperty(IContentDescriptionExtended.ENCODING_MEMENTO);
		if (javaCharset != null) {
			result = javaCharset;
		} else {
			if (encodingMemento != null) {
				result = encodingMemento.getDetectedCharsetName();
			} else {
				result = detectedCharset;
			}
		}
		return result;
	}

	/**
	 * Very mechanical method, just to read the characters, once the reader is
	 * correctly created. Can throw MalFormedInputException.
	 */
	protected StringBuffer readInputStream(Reader reader) throws IOException {

		int fBlocksRead = 0;
		StringBuffer buffer = new StringBuffer();
		int numRead = 0;
		try {
			char tBuff[] = new char[CodedIO.MAX_BUF_SIZE];
			while ((numRead = reader.read(tBuff, 0, tBuff.length)) != -1) {
				buffer.append(tBuff, 0, numRead);
				fBlocksRead++;
			}
		} catch (MalformedInputException e) {
			String charset = getCharset(reader);
			throw new MalformedInputExceptionWithDetail(charset, fBlocksRead * CodedIO.MAX_BUF_SIZE + e.getInputLength());
		}
		return buffer;
	}

	public void release(IFile iFile, IProgressMonitor monitor) throws CoreException {
		IPath locationPath = iFile.getFullPath();
		getBufferManager().disconnect(locationPath, monitor);

	}

	public void reload(IEncodedDocument document, Reader reader) throws IOException {
		setDocumentContentsFromReader(document, reader);

	}

	protected void setDocumentContentsFromReader(IEncodedDocument structuredDocument, Reader reader) throws IOException {

		StringBuffer allText = readInputStream(reader);
		structuredDocument.set(allText.toString());
	}

}