xpcom/ds/nsIINIParser.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is Mozilla XPCOM.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Benjamin Smedberg <benjamin@smedbergs.us>
  18  *
  19  * Portions created by the Initial Developer are Copyright (C) 2005
  20  * the Mozilla Foundation <http://www.mozilla.org/>. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 interface nsIUTF8StringEnumerator;
  41 interface nsILocalFile;
  42
  43 [scriptable, uuid(7eb955f6-3e78-4d39-b72f-c1bf12a94bce)]
  44 interface nsIINIParser : nsISupports
  45 {
  46   /**
  47    * Enumerates the [section]s available in the INI file.
  48    */
  49   nsIUTF8StringEnumerator getSections();
  50
  51   /**
  52    * Enumerates the keys available within a section.
  53    */
  54   nsIUTF8StringEnumerator getKeys(in AUTF8String aSection);
  55
  56   /**
  57    * Get the value of a string for a particular section and key.
  58    */
  59   AUTF8String getString(in AUTF8String aSection, in AUTF8String aKey);
  60 };
  61
  62 [scriptable, uuid(712dc5da-8d09-45d0-ba2e-de27eb384c4c)]
  63 interface nsIINIParserWriter : nsISupports
  64 {
  65   /**
  66    * Set the value of a string for a particular section and key.
  67    */
  68   void setString(in AUTF8String aSection, in AUTF8String aKey, in AUTF8String aValue);
  69
  70   /**
  71    * Write to the INI file.
  72    */
  73   void writeFile([optional] in nsILocalFile aINIFile);
  74 };
  75
  76 [scriptable, uuid(ccae7ea5-1218-4b51-aecb-c2d8ecd46af9)]
  77 interface nsIINIParserFactory : nsISupports
  78 {
  79   /**
  80    * Create an iniparser instance from a local file.
  81    */
  82   nsIINIParser createINIParser(in nsILocalFile aINIFile);
  83 };