X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0e3610442874eeea4062cece31cdc4f314878fa8..36d9119341753b2f6f606571702a9b906050a07c:/include/wx/html/htmltag.h diff --git a/include/wx/html/htmltag.h b/include/wx/html/htmltag.h index 88aacdd4dd..758e1d3a0e 100644 --- a/include/wx/html/htmltag.h +++ b/include/wx/html/htmltag.h @@ -12,56 +12,44 @@ #define _WX_HTMLTAG_H_ #ifdef __GNUG__ -#pragma interface +#pragma interface "htmltag.h" #endif #include "wx/defs.h" -#if wxUSE_HTML +#if wxUSE_HTML -//-------------------------------------------------------------------------------- -// wxHtmlTagsCache -// !! INTERNAL STRUCTURE !! Do not use in your program! -// This structure contains information on positions of tags -// in the string being parsed -//-------------------------------------------------------------------------------- +#include "wx/object.h" -typedef struct { - int Key; - // this is "pos" value passed to wxHtmlTag's constructor. - // it is position of '<' character of the tag - int End1, End2; - // end positions for the tag: - // end1 is '<' of ending tag, - // end2 is '>' or both are - // -1 if there is no ending tag for this one... - // or -2 if this is ending tag - wxChar *Name; - // name of this tag - } sCacheItem; +class WXDLLEXPORT wxColour; +class WXDLLEXPORT wxHtmlEntitiesParser; +//----------------------------------------------------------------------------- +// wxHtmlTagsCache +// - internal wxHTML class, do not use! +//----------------------------------------------------------------------------- +struct wxHtmlCacheItem; -class wxHtmlTagsCache : public wxObject +class WXDLLEXPORT wxHtmlTagsCache : public wxObject { DECLARE_DYNAMIC_CLASS(wxHtmlTagsCache) - private: - sCacheItem *m_Cache; - int m_CacheSize; - int m_CachePos; +private: + wxHtmlCacheItem *m_Cache; + int m_CacheSize; + int m_CachePos; - public: - wxHtmlTagsCache() : wxObject() {m_CacheSize = 0; m_Cache = NULL;} - wxHtmlTagsCache(const wxString& source); - ~wxHtmlTagsCache() {free(m_Cache);} +public: + wxHtmlTagsCache() : wxObject() {m_CacheSize = 0; m_Cache = NULL;} + wxHtmlTagsCache(const wxString& source); + ~wxHtmlTagsCache() {free(m_Cache);} - void QueryTag(int at, int* end1, int* end2); - // Finds parameters for tag starting at at and fills the variables + // Finds parameters for tag starting at at and fills the variables + void QueryTag(int at, int* end1, int* end2); }; - //-------------------------------------------------------------------------------- // wxHtmlTag // This represents single tag. It is used as internal structure @@ -72,63 +60,88 @@ class WXDLLEXPORT wxHtmlTag : public wxObject { DECLARE_CLASS(wxHtmlTag) - public: - wxHtmlTag(const wxString& source, int pos, int end_pos, wxHtmlTagsCache* cache); - // constructs wxHtmlTag object based on HTML tag. - // The tag begins (with '<' character) at position pos in source - // end_pos is position where parsing ends (usually end of document) - - inline wxString GetName() const {return m_Name;} - // Returns tag's name in uppercase. - - bool HasParam(const wxString& par) const; - // Returns TRUE if the tag has given parameter. Parameter - // should always be in uppercase. - // Example : HasParam("SRC") returns TRUE - - wxString GetParam(const wxString& par, bool with_commas = FALSE) const; - // Returns value of the param. Value is in uppercase unless it is - // enclosed with " - // Example :

GetParam("ALIGN") returns (RIGHT) - //

GetParam("SRC") returns (WhaT.jpg) - // (or ("WhaT.jpg") if with_commas == TRUE) - - int ScanParam(const wxString& par, wxChar *format, void *param) const; - // Scans param like scanf() functions family do. - // Example : ScanParam("COLOR", "\"#%X\"", &clr); - // This is always with with_commas=FALSE - // Returns number of scanned values - // (like sscanf() does) - // NOTE: unlike scanf family, this function only accepts - // *one* parameter ! - - inline const wxString& GetAllParams() const {return m_Params;} - // Returns string containing all params. - - inline bool IsEnding() const {return m_Ending;} - // return TRUE if this is ending tag () or FALSE - // if it isn't () - - inline bool HasEnding() const {return m_End1 >= 0;} - // return TRUE if this is ending tag () or FALSE - // if it isn't () - - inline int GetBeginPos() const {return m_Begin;} - // returns beginning position of _internal_ block of text - // See explanation (returned value is marked with *): - // bla bla bla * bla bla intenal text bla bla - inline int GetEndPos1() const {return m_End1;} - // returns ending position of _internal_ block of text. - // bla bla bla bla bla intenal text* bla bla - inline int GetEndPos2() const {return m_End2;} - // returns end position 2 : - // bla bla bla bla bla internal text* bla bla - - private: - wxString m_Name, m_Params; - int m_Begin, m_End1, m_End2; - bool m_Ending; +protected: + // constructs wxHtmlTag object based on HTML tag. + // The tag begins (with '<' character) at position pos in source + // end_pos is position where parsing ends (usually end of document) + wxHtmlTag(wxHtmlTag *parent, + const wxString& source, int pos, int end_pos, + wxHtmlTagsCache *cache, + wxHtmlEntitiesParser *entParser); + friend class wxHtmlParser; +public: + ~wxHtmlTag(); + + wxHtmlTag *GetParent() const {return m_Parent;} + wxHtmlTag *GetFirstSibling() const; + wxHtmlTag *GetLastSibling() const; + wxHtmlTag *GetChildren() const { return m_FirstChild; } + wxHtmlTag *GetPreviousSibling() const { return m_Prev; } + wxHtmlTag *GetNextSibling() const {return m_Next; } + // Return next tag, as if tree had been flattened + wxHtmlTag *GetNextTag() const; + + // Returns tag's name in uppercase. + inline wxString GetName() const {return m_Name;} + + // Returns TRUE if the tag has given parameter. Parameter + // should always be in uppercase. + // Example : HasParam("SRC") returns TRUE + bool HasParam(const wxString& par) const; + + // Returns value of the param. Value is in uppercase unless it is + // enclosed with " + // Example :

GetParam("ALIGN") returns (RIGHT) + //

GetParam("SRC") returns (WhaT.jpg) + // (or ("WhaT.jpg") if with_commas == TRUE) + wxString GetParam(const wxString& par, bool with_commas = FALSE) const; + + // Convenience functions: + bool GetParamAsColour(const wxString& par, wxColour *clr) const; + bool GetParamAsInt(const wxString& par, int *clr) const; + + // Scans param like scanf() functions family does. + // Example : ScanParam("COLOR", "\"#%X\"", &clr); + // This is always with with_commas=FALSE + // Returns number of scanned values + // (like sscanf() does) + // NOTE: unlike scanf family, this function only accepts + // *one* parameter ! + int ScanParam(const wxString& par, const wxChar *format, void *param) const; + + // Returns string containing all params. + wxString GetAllParams() const; + +#if WXWIN_COMPATIBILITY_2_2 + // return TRUE if this is ending tag () or FALSE + // if it isn't () + inline bool IsEnding() const {return FALSE;} +#endif + // return TRUE if this there is matching ending tag + inline bool HasEnding() const {return m_End1 >= 0;} + + // returns beginning position of _internal_ block of text + // See explanation (returned value is marked with *): + // bla bla bla * bla bla intenal text bla bla + inline int GetBeginPos() const {return m_Begin;} + // returns ending position of _internal_ block of text. + // bla bla bla bla bla intenal text* bla bla + inline int GetEndPos1() const {return m_End1;} + // returns end position 2 : + // bla bla bla bla bla internal text* bla bla + inline int GetEndPos2() const {return m_End2;} + +private: + wxString m_Name; + int m_Begin, m_End1, m_End2; + wxArrayString m_ParamNames, m_ParamValues; + + // DOM tree relations: + wxHtmlTag *m_Next; + wxHtmlTag *m_Prev; + wxHtmlTag *m_FirstChild, *m_LastChild; + wxHtmlTag *m_Parent; };