src/include/common/vocl/VProperty.h

00001 /*
00002  * Funambol is a mobile platform developed by Funambol, Inc. 
00003  * Copyright (C) 2003 - 2007 Funambol, Inc.
00004  * 
00005  * This program is free software; you can redistribute it and/or modify it under
00006  * the terms of the GNU Affero General Public License version 3 as published by
00007  * the Free Software Foundation with the addition of the following permission 
00008  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
00009  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 
00010  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
00011  * 
00012  * This program is distributed in the hope that it will be useful, but WITHOUT
00013  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00014  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00015  * details.
00016  * 
00017  * You should have received a copy of the GNU Affero General Public License 
00018  * along with this program; if not, see http://www.gnu.org/licenses or write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
00020  * MA 02110-1301 USA.
00021  * 
00022  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 
00023  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
00024  * 
00025  * The interactive user interfaces in modified source and object code versions
00026  * of this program must display Appropriate Legal Notices, as required under
00027  * Section 5 of the GNU Affero General Public License version 3.
00028  * 
00029  * In accordance with Section 7(b) of the GNU Affero General Public License
00030  * version 3, these Appropriate Legal Notices must retain the display of the
00031  * "Powered by Funambol" logo. If the display of the logo is not reasonably 
00032  * feasible for technical reasons, the Appropriate Legal Notices must display
00033  * the words "Powered by Funambol".
00034  */
00035 
00036 
00037 #ifndef INCL_VIRTUAL_PROPERTY
00038 #define INCL_VIRTUAL_PROPERTY
00039 
00041 #include "base/fscapi.h"
00042 #include "base/util/WKeyValuePair.h"
00043 #include "base/util/ArrayList.h"
00044 
00045 
00046 // Quoted-Printable formatted lines should be max 76 chars long.
00047 #define QP_MAX_LINE_LEN             70
00048 #define VCARD_MAX_LINE_LEN          76
00049 
00050 
00051 // These are special chars to escape in vCard/vCal/vTodo (version 2.1 - 3.0)
00052 #define VCARD21_SPECIAL_CHARS       TEXT(";\\")
00053 #define VCARD30_SPECIAL_CHARS       TEXT(";\\,")
00054 #define RFC822_LINE_BREAK           TEXT("\r\n")
00055 #include "base/globalsdef.h"
00056 
00057 BEGIN_NAMESPACE
00058 
00059 
00060 // ------------ Public functions --------------
00061 WCHAR* escapeSpecialChars(const WCHAR* inputString, WCHAR* version);
00062 char*    convertToQP(const char* input, int start);
00063 bool     encodingIsNeed(const char *in);
00064 WCHAR* folding(const WCHAR* inputString, const int maxLine);
00065 WCHAR* unfolding(const WCHAR* inputString);
00066 
00067 
00068 
00069 // ------------ Class VProperty ---------------
00070 
00071 class VProperty : public ArrayElement {
00072 
00073 private:
00074 
00075     WCHAR* name;
00076     void set(WCHAR** p, const WCHAR* v);
00077 
00078     ArrayList* parameters;
00079     ArrayList* values;
00080 
00081     // This is only used as a buffer for 'getValue()'
00082     WCHAR* valueBuf;
00083 
00084  public:
00085 
00086     VProperty(const WCHAR* propName , const WCHAR* propValue  = NULL);
00087     ~VProperty();
00088     ArrayElement* clone();
00089     void setName (const WCHAR* name);
00090     WCHAR* getName(WCHAR* buf = NULL, int size = -1);
00091 
00092     void addValue(const WCHAR* value);
00093     bool removeValue(const int index);
00094     WCHAR* getValue(int index);
00095     int valueCount();
00096 
00097     // For back-compatibility (to remove)
00098     WCHAR* getValue(WCHAR* buf = NULL);
00099     void setValue (const WCHAR* value);
00100     WCHAR* getPropComponent(int i);
00101 
00102     void addParameter(const WCHAR* paramName, const WCHAR* paramValue);
00103     void removeParameter(WCHAR* paramName);
00104     bool containsParameter(WCHAR* paramName);
00105     // Warning: the name does not always uniquely identify
00106     // the parameter, some of them may occur multiple times.
00107     // Use getParameterValue(int index) to get the value which
00108     // corresponds to a specific parameter.
00109     WCHAR* getParameterValue(WCHAR* paramName);
00110     WCHAR* getParameterValue(int index);
00111     WCHAR* getParameter(int index);
00112     int parameterCount();
00113     bool equalsEncoding(WCHAR* encoding);
00114     //WCHAR* getPropComponent(int i);
00115     bool isType(WCHAR* type);
00116     WCHAR* toString(WCHAR* version = NULL);
00117 
00118  };
00119 
00120 
00121 END_NAMESPACE
00122 
00124 #endif

Generated on Fri Jul 25 15:04:15 2008 for Funambol C++ Client Library by  doxygen 1.5.1