C_CMMLTag.h

Go to the documentation of this file.
00001 /*
00002    Copyright (C) 2003, 2004 Zentaro Kavanagh
00003    
00004    Copyright (C) 2003, 2004 Commonwealth Scientific and Industrial Research
00005    Organisation (CSIRO) Australia
00006 
00007    Redistribution and use in source and binary forms, with or without
00008    modification, are permitted provided that the following conditions
00009    are met:
00010 
00011    - Redistributions of source code must retain the above copyright
00012    notice, this list of conditions and the following disclaimer.
00013 
00014    - Redistributions in binary form must reproduce the above copyright
00015    notice, this list of conditions and the following disclaimer in the
00016    documentation and/or other materials provided with the distribution.
00017 
00018    - Neither the name of CSIRO Australia nor the names of its
00019    contributors may be used to endorse or promote products derived from
00020    this software without specific prior written permission.
00021 
00022    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00023    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00024    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
00025    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE ORGANISATION OR
00026    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00027    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00028    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00029    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00030    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00031    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00032    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 */
00034 #pragma once
00035 
00036 //STL Include Files
00037 #include <string>
00038 
00039 #include <libCMMLTags/config.h>
00040 
00041 using namespace std;
00042 
00043 //DESCRIPTION:
00044 //      This is the base class for all tags. This is an abstract class.
00045 
00046 //PURE VIRTUAL FUNCTIONS
00047 //      wstring toString();                                     //Turn the tag to a string
00048 
00049 class LIBCMMLTAGS_API C_CMMLTag
00050 {
00051 public:
00052         //Constructors
00053         C_CMMLTag(void);
00054         virtual ~C_CMMLTag(void);
00055 
00056         virtual C_CMMLTag* genericClone() = 0;
00057         
00058 
00059         //Enumerations
00060         enum eTagType {
00061                 UNKNOWN,
00062                 IMPORT,
00063                 STREAM,
00064                 META,
00065                 HEAD,
00066                 TITLE,
00067                 BASE,
00068                 CLIP,
00069                 ANCHOR,
00070                 IMAGE,
00071                 DESC,
00072                 PARAM,
00073                 BAD_TAG = 1000
00074         };
00075         
00077         wstring id();
00078 
00080         void setId(wstring inId);
00081 
00083         eTagType tagType();
00084 
00086         virtual wstring toString() = 0;
00087 protected:
00088         //Property Data
00089         wstring mId;
00090         eTagType mTagType;
00091 
00092         //Protected Helper Methods
00093         virtual void privateClone(C_CMMLTag* outTag);
00094 
00096         wstring makeAttribute(wstring inElemName, wstring inElemContent);
00097 
00098         wstring makeRequiredAttribute(wstring inElemName, wstring inElemContent);
00099 
00101         wstring escapeEntities(wstring inString);
00102 
00104         wstring replaceAll(wstring inOriginal, wchar_t inReplaceThis, wstring inWithThis);
00105         
00106 };

Generated on Tue Feb 15 14:54:13 2005 for oggdsf by  doxygen 1.3.9