Back to index

lightning-sunbird  0.9+nobinonly
nsNameValuePairDB.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Brian Stell <bstell@ix.netcom.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef NSNAMEVALUEPAIRDB_H
00040 #define NSNAMEVALUEPAIRDB_H
00041 
00042 #include "nsString.h"
00043 
00044 #define FC_BUF_LEN 1024
00045 
00046 #define NVPDB_MIN_BUFLEN 100
00047 
00048 //
00049 // Errors
00050 //
00051 #define NVPDB_END_OF_FILE       0
00052 #define NVPDB_BUFFER_TOO_SMALL -1
00053 #define NVPDB_END_OF_GROUP     -2
00054 #define NVPDB_FILE_IO_ERROR    -3
00055 #define NVPDB_GARBLED_LINE     -4
00056 
00057 class nsNameValuePairDB {
00058 public:
00059   nsNameValuePairDB();
00060   ~nsNameValuePairDB();
00061 
00062   inline PRBool HadError() { return mError; };
00063   // implement this to re-read an element if it is larger than the buffer
00064   // PRInt32 GetCurrentElement(const char** aName, const char** aValue,
00065   //                           char *aBuffer, PRUint32 aBufferLen);
00066   PRBool  GetNextGroup(const char** aType);
00067   PRBool  GetNextGroup(const char** aType, const char* aName);
00068   PRBool  GetNextGroup(const char** aType, const char* aName, int aLen);
00069   PRInt32 GetNextElement(const char** aName, const char** aValue);
00070   PRInt32 GetNextElement(const char** aName, const char** aValue,
00071                          char *aBuffer, PRUint32 aBufferLen);
00072   PRBool  OpenForRead(const nsACString& aCatalogName);     // native charset
00073   PRBool  OpenTmpForWrite(const nsACString& aCatalogName); // native charset
00074   PRBool  PutElement(const char* aName, const char* aValue);
00075   PRBool  PutEndGroup(const char* aType);
00076   PRBool  PutStartGroup(const char* aType);
00077   PRBool  RenameTmp(const char* aCatalogName);
00078 
00079 protected:
00080   PRBool         CheckHeader();
00081   PRUint16       mMajorNum;
00082   PRUint16       mMinorNum;
00083   PRUint16       mMaintenanceNum;
00084   FILE*          mFile;
00085   char           mBuf[FC_BUF_LEN];
00086   PRInt32        mCurrentGroup;
00087   PRPackedBool   mAtEndOfGroup;
00088   PRPackedBool   mAtEndOfCatalog;
00089   PRPackedBool   mError;
00090 private:
00091 };
00092 
00093 #endif /* NSNAMEVALUEPAIRDB_H */
00094