/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Verbosio XML editor.
 *
 * The Initial Developer of the Original Code is
 * Alexander J. Vincent <ajvincent@gmail.com>.
 * Portions created by the Initial Developer are Copyright (C) 2005
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"
#include "xeITransaction.idl"
#include "nsIScriptError.idl"
#include "xeIDocumentWrapper.idl"

/* This interface allows us to have a language pack editor for non-XML documents.
 * For instance, a CSS stylesheet, or a Document Type Definition (DTD).
 *
 * XML language packs also implement this interface; this is a baseline for all
 * language packs.
 * 
 * xeILanguagePack classes start with at least one of the prefixes:
 * "@verbosio.mozdev.org/language-pack-service;1?contentType="
 * "@verbosio.mozdev.org/language-pack-service;1?namespaceURI="
 */

[scriptable, uuid(31ec365a-81e3-432e-bc31-4c53625c3e56)]
interface xeILanguagePackService : nsISupports {
  // The MIME content type associated with the language.
  readonly attribute ACString contentType;

  // The URI of the language's specification.
  readonly attribute ACString specificationURI;

  // A user-readable description of the language.
  readonly attribute ACString description;

  // An identifier unique for the language.
  readonly attribute ACString id;

  // A version for the language.
  readonly attribute ACString version;

  /**
   * Get a blank transaction as requested by the user.
   *
   * @param transactionName A unique transaction class's name.
   *
   * @return xeITransaction in original state.
   */
  xeITransaction getNewTransaction(in ACString transactionName);

  /**
   * Check for a syntax error in a document.
   *
   * @param xeIDocumentWrapper wrapper for the document's source.
   *
   * @return nsIScriptError if there is a syntax or validity error, or null.
   * @note Return value will have warning flag for non-syntax errors.
   */
  nsIScriptError getFirstSyntaxError(in xeIDocumentWrapper wrapper);
};
