/* ***** 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 "nsISupportsPrimitives.idl"
#include "nsISimpleEnumerator.idl"

interface xeIDocumentWrapper;

/* This interface defines common paths for a directory on both the local and
 * remote file locations.  To give an example, if the user has a public
 * document at http://verbosio.mozdev.org/samples/root/root.xul, and the
 * same file exists on his local system at
 * file:///c:/verbosio/www/samples/root/root.xul, then they have different
 * baseURI values ("http://verbosio.mozdev.org/", "file:///c:/verbosio/www/"),
 * but the same path after that ("samples/root/root.xul").  If you have
 * multiple documents within the same directory locally, and they match the
 * desired directory structure on the public URI, this becomes more useful.
 *
 * Sample types include:
 * "virtual" - Virtual base URI, based on the virtual:// protocol.
 * "public"  - Equivalent to the href attribute of <html:base/>.
 * "staging" - If the user wants a test directory on the server,
 *             this would be the base URI for it.
 * "local"   - The directory where relevant files live on the local computer.
 */
[scriptable, uuid(54fd0313-ce06-4ad9-8260-00e387e15781)]
interface xeIBaseURIMap : nsISupports {
  /**
   * Get the types stored in this base URI map as an array
   *
   * @return aCount The number of types.
   * @return aValues The array of types.
   */
  void getURITypes(out PRUint32 count, 
                   [array, size_is(count), retval] out wstring array);
                   
  /**
   * Get a base URI for a given type.
   *
   * @param type The URI type to look up.
   *
   * @return URI as a string.
   */
  ACString getURI(in ACString type);

  /**
   * Add a type to the base URI map.
   *
   * @param aType New type to add.
   * @param aURI  Base URI to add for the given type.
   */
  void addType(in ACString type, in ACString URI);

  /**
   * Get the primary local file path.
   */
  ACString getPrimaryLocalURI(in ACString aPath);
};
