include/wx/html/htmltag.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/html/htmltag.h
   3 // Purpose:     wxHtmlTag class (represents single tag)
   4 // Author:      Vaclav Slavik
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) 1999 Vaclav Slavik
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_HTMLTAG_H_
  11 #define _WX_HTMLTAG_H_
  12
  13 #include "wx/defs.h"
  14
  15 #if wxUSE_HTML
  16
  17 #include "wx/object.h"
  18 #include "wx/arrstr.h"
  19
  20 class WXDLLIMPEXP_FWD_CORE wxColour;
  21 class WXDLLIMPEXP_FWD_HTML wxHtmlEntitiesParser;
  22
  23 //-----------------------------------------------------------------------------
  24 // wxHtmlTagsCache
  25 //          - internal wxHTML class, do not use!
  26 //-----------------------------------------------------------------------------
  27
  28 class wxHtmlTagsCacheData;
  29
  30 class WXDLLIMPEXP_HTML wxHtmlTagsCache
  31 {
  32 private:
  33     wxHtmlTagsCacheData *m_Cache;
  34     int m_CachePos;
  35
  36     wxHtmlTagsCacheData& Cache() { return *m_Cache; }
  37
  38 public:
  39     wxHtmlTagsCache() {m_Cache = NULL;}
  40     wxHtmlTagsCache(const wxString& source);
  41     virtual ~wxHtmlTagsCache();
  42
  43     // Finds parameters for tag starting at at and fills the variables
  44     void QueryTag(const wxString::const_iterator& at,
  45                   const wxString::const_iterator& inputEnd,
  46                   wxString::const_iterator *end1,
  47                   wxString::const_iterator *end2,
  48                   bool *hasEnding);
  49
  50     wxDECLARE_NO_COPY_CLASS(wxHtmlTagsCache);
  51 };
  52
  53
  54 //--------------------------------------------------------------------------------
  55 // wxHtmlTag
  56 //                  This represents single tag. It is used as internal structure
  57 //                  by wxHtmlParser.
  58 //--------------------------------------------------------------------------------
  59
  60 class WXDLLIMPEXP_HTML wxHtmlTag
  61 {
  62 protected:
  63     // constructs wxHtmlTag object based on HTML tag.
  64     // The tag begins (with '<' character) at position pos in source
  65     // end_pos is position where parsing ends (usually end of document)
  66     wxHtmlTag(wxHtmlTag *parent,
  67               const wxString *source,
  68               const wxString::const_iterator& pos,
  69               const wxString::const_iterator& end_pos,
  70               wxHtmlTagsCache *cache,
  71               wxHtmlEntitiesParser *entParser);
  72     friend class wxHtmlParser;
  73 public:
  74     ~wxHtmlTag();
  75
  76     wxHtmlTag *GetParent() const {return m_Parent;}
  77     wxHtmlTag *GetFirstSibling() const;
  78     wxHtmlTag *GetLastSibling() const;
  79     wxHtmlTag *GetChildren() const { return m_FirstChild; }
  80     wxHtmlTag *GetPreviousSibling() const { return m_Prev; }
  81     wxHtmlTag *GetNextSibling() const {return m_Next; }
  82     // Return next tag, as if tree had been flattened
  83     wxHtmlTag *GetNextTag() const;
  84
  85     // Returns tag's name in uppercase.
  86     inline wxString GetName() const {return m_Name;}
  87
  88     // Returns true if the tag has given parameter. Parameter
  89     // should always be in uppercase.
  90     // Example : <IMG SRC="test.jpg"> HasParam("SRC") returns true
  91     bool HasParam(const wxString& par) const;
  92
  93     // Returns value of the param. Value is in uppercase unless it is
  94     // enclosed with "
  95     // Example : <P align=right> GetParam("ALIGN") returns (RIGHT)
  96     //           <P IMG SRC="WhaT.jpg"> GetParam("SRC") returns (WhaT.jpg)
  97     //                           (or ("WhaT.jpg") if with_quotes == true)
  98     wxString GetParam(const wxString& par, bool with_quotes = false) const;
  99
 100     // Return true if the string could be parsed as an HTML colour and false
 101     // otherwise.
 102     static bool ParseAsColour(const wxString& str, wxColour *clr);
 103
 104     // Convenience functions:
 105     bool GetParamAsColour(const wxString& par, wxColour *clr) const;
 106     bool GetParamAsInt(const wxString& par, int *clr) const;
 107     bool GetParamAsIntOrPercent(const wxString& param,
 108                                 int* value, bool& isPercent) const;
 109
 110     // Scans param like scanf() functions family does.
 111     // Example : ScanParam("COLOR", "\"#%X\"", &clr);
 112     // This is always with with_quotes=false
 113     // Returns number of scanned values
 114     // (like sscanf() does)
 115     // NOTE: unlike scanf family, this function only accepts
 116     //       *one* parameter !
 117     int ScanParam(const wxString& par, const char *format, void *param) const;
 118     int ScanParam(const wxString& par, const wchar_t *format, void *param) const;
 119
 120     // Returns string containing all params.
 121     wxString GetAllParams() const;
 122
 123     // return true if there is matching ending tag
 124     inline bool HasEnding() const {return m_hasEnding;}
 125
 126     // returns beginning position of _internal_ block of text as iterator
 127     // into parser's source string (see wxHtmlParser::GetSource())
 128     // See explanation (returned value is marked with *):
 129     // bla bla bla <MYTAG>* bla bla intenal text</MYTAG> bla bla
 130     wxString::const_iterator GetBeginIter() const
 131         { return m_Begin; }
 132     // returns ending position of _internal_ block of text as iterator
 133     // into parser's source string (see wxHtmlParser::GetSource()):
 134     // bla bla bla <MYTAG> bla bla intenal text*</MYTAG> bla bla
 135     wxString::const_iterator GetEndIter1() const { return m_End1; }
 136     // returns end position 2 as iterator
 137     // into parser's source string (see wxHtmlParser::GetSource()):
 138     // bla bla bla <MYTAG> bla bla internal text</MYTAG>* bla bla
 139     wxString::const_iterator GetEndIter2() const { return m_End2; }
 140
 141 #if WXWIN_COMPATIBILITY_2_8
 142     // use GetBeginIter(), GetEndIter1() and GetEndIter2() instead
 143     wxDEPRECATED( inline int GetBeginPos() const );
 144     wxDEPRECATED( inline int GetEndPos1() const );
 145     wxDEPRECATED( inline int GetEndPos2() const );
 146 #endif // WXWIN_COMPATIBILITY_2_8
 147
 148 private:
 149     wxString m_Name;
 150     bool m_hasEnding;
 151     wxString::const_iterator m_Begin, m_End1, m_End2;
 152     wxArrayString m_ParamNames, m_ParamValues;
 153 #if WXWIN_COMPATIBILITY_2_8
 154     wxString::const_iterator m_sourceStart;
 155 #endif
 156
 157     // DOM tree relations:
 158     wxHtmlTag *m_Next;
 159     wxHtmlTag *m_Prev;
 160     wxHtmlTag *m_FirstChild, *m_LastChild;
 161     wxHtmlTag *m_Parent;
 162
 163     wxDECLARE_NO_COPY_CLASS(wxHtmlTag);
 164 };
 165
 166
 167 #if WXWIN_COMPATIBILITY_2_8
 168 inline int wxHtmlTag::GetBeginPos() const { return m_Begin - m_sourceStart; }
 169 inline int wxHtmlTag::GetEndPos1() const { return m_End1 - m_sourceStart; }
 170 inline int wxHtmlTag::GetEndPos2() const { return m_End2 - m_sourceStart; }
 171 #endif // WXWIN_COMPATIBILITY_2_8
 172
 173
 174
 175
 176 #endif // wxUSE_HTML
 177
 178 #endif // _WX_HTMLTAG_H_
 179