replace use of 'long/int bitmapType' with 'wxBitmapType bitmapType' in richtext and...

[wxWidgets.git] / include / wx / html / htmlpars.h

diff --git a/include/wx/html/htmlpars.h b/include/wx/html/htmlpars.h
index 446fa3cba2ce02add0ddb71eda88e8e14cb21621..92dc1be5756bc6e8b79846a2a7b06f356c5bcfc0 100644 (file)
--- a/include/wx/html/htmlpars.h
+++ b/include/wx/html/htmlpars.h
@@ -15,17 +15,27 @@
 
 #include "wx/html/htmltag.h"
 #include "wx/filesys.h"
 
 #include "wx/html/htmltag.h"
 #include "wx/filesys.h"

-#include "wx/hash.h"
+#include "wx/hashmap.h"
+#include "wx/hashset.h"
+#include "wx/vector.h"

 #include "wx/fontenc.h"
 
 #include "wx/fontenc.h"
 

-class WXDLLIMPEXP_BASE wxMBConv;
-class WXDLLIMPEXP_HTML wxHtmlParser;
-class WXDLLIMPEXP_HTML wxHtmlTagHandler;
-class WXDLLIMPEXP_HTML wxHtmlEntitiesParser;
+class WXDLLIMPEXP_FWD_BASE wxMBConv;
+class WXDLLIMPEXP_FWD_HTML wxHtmlParser;
+class WXDLLIMPEXP_FWD_HTML wxHtmlTagHandler;
+class WXDLLIMPEXP_FWD_HTML wxHtmlEntitiesParser;

 
 class wxHtmlTextPieces;
 class wxHtmlParserState;
 
 
 class wxHtmlTextPieces;
 class wxHtmlParserState;
 

+WX_DECLARE_HASH_SET_WITH_DECL(wxHtmlTagHandler*,
+                              wxPointerHash, wxPointerEqual,
+                              wxHtmlTagHandlersSet,
+                              class WXDLLIMPEXP_HTML);
+WX_DECLARE_STRING_HASH_MAP_WITH_DECL(wxHtmlTagHandler*,
+                                     wxHtmlTagHandlersHash,
+                                     class WXDLLIMPEXP_HTML);
+

 
 enum wxHtmlURLType
 {
 
 enum wxHtmlURLType
 {


@@ -35,7 +45,7 @@ enum wxHtmlURLType
 };
 
 // This class handles generic parsing of HTML document : it scans
 };
 
 // This class handles generic parsing of HTML document : it scans

-// the document and divide it into blocks of tags (where one block
+// the document and divides it into blocks of tags (where one block

 // consists of starting and ending tag and of text between these
 // 2 tags.
 class WXDLLIMPEXP_HTML wxHtmlParser : public wxObject
 // consists of starting and ending tag and of text between these
 // 2 tags.
 class WXDLLIMPEXP_HTML wxHtmlParser : public wxObject


@@ -59,7 +69,7 @@ public:
     // This method does these things:
     // 1. call InitParser(source);
     // 2. call DoParsing();
     // This method does these things:
     // 1. call InitParser(source);
     // 2. call DoParsing();

-    // 3. call GetProduct(); (it's return value is then returned)
+    // 3. call GetProduct(); (its return value is then returned)

     // 4. call DoneParser();
     wxObject* Parse(const wxString& source);
 
     // 4. call DoneParser();
     wxObject* Parse(const wxString& source);
 


@@ -73,7 +83,8 @@ public:
 
     // Parses the m_Source from begin_pos to end_pos-1.
     // (in noparams version it parses whole m_Source)
 
     // Parses the m_Source from begin_pos to end_pos-1.
     // (in noparams version it parses whole m_Source)

-    void DoParsing(int begin_pos, int end_pos);
+    void DoParsing(const wxString::const_iterator& begin_pos,
+                   const wxString::const_iterator& end_pos);

     void DoParsing();
 
     // Returns pointer to the tag at parser's current position
     void DoParsing();
 
     // Returns pointer to the tag at parser's current position


@@ -96,18 +107,18 @@ public:
     //     <it name="two" value="2">
     //   </myitems>
     //   <it> This last it has different meaning, we don't want it to be parsed by myitems handler!
     //     <it name="two" value="2">
     //   </myitems>
     //   <it> This last it has different meaning, we don't want it to be parsed by myitems handler!

-    // handler can handle only 'myitems' (e.g. it's GetSupportedTags returns "MYITEMS")
+    // handler can handle only 'myitems' (e.g. its GetSupportedTags returns "MYITEMS")

     // you can call PushTagHandler(handler, "IT") when you find <myitems>
     // and call PopTagHandler() when you find </myitems>
     // you can call PushTagHandler(handler, "IT") when you find <myitems>
     // and call PopTagHandler() when you find </myitems>

-    void PushTagHandler(wxHtmlTagHandler *handler, wxString tags);
+    void PushTagHandler(wxHtmlTagHandler *handler, const wxString& tags);

 
     // Restores state before last call to PushTagHandler
     void PopTagHandler();
 
 
     // Restores state before last call to PushTagHandler
     void PopTagHandler();
 

-    wxString* GetSource() {return &m_Source;}
+    const wxString* GetSource() {return m_Source;}

     void SetSource(const wxString& src);
 
     void SetSource(const wxString& src);
 

-    // Sets HTML source and remebers current parser's state so that it can
+    // Sets HTML source and remembers current parser's state so that it can

     // later be restored. This is useful for on-line modifications of
     // HTML source (for example, <pre> handler replaces spaces with &nbsp;
     // and newlines with <br>)
     // later be restored. This is useful for on-line modifications of
     // HTML source (for example, <pre> handler replaces spaces with &nbsp;
     // and newlines with <br>)


@@ -116,6 +127,10 @@ public:
     // empty
     virtual bool RestoreState();
 
     // empty
     virtual bool RestoreState();
 

+    // Returns HTML source inside the element (i.e. between the starting
+    // and ending tag)
+    wxString GetInnerSource(const wxHtmlTag& tag);
+

     // Parses HTML string 'markup' and extracts charset info from <meta> tag
     // if present. Returns empty string if the tag is missing.
     // For wxHTML's internal use.
     // Parses HTML string 'markup' and extracts charset info from <meta> tag
     // if present. Returns empty string if the tag is missing.
     // For wxHTML's internal use.


@@ -124,20 +139,27 @@ public:
     // Returns entity parser object, used to substitute HTML &entities;
     wxHtmlEntitiesParser *GetEntitiesParser() const { return m_entitiesParser; }
 
     // Returns entity parser object, used to substitute HTML &entities;
     wxHtmlEntitiesParser *GetEntitiesParser() const { return m_entitiesParser; }
 

+    // Returns true if the tag starting at the given position is a comment tag
+    //
+    // p should point to '<' character and is modified to point to the closing
+    // '>' of the end comment tag if this is indeed a comment
+    static bool
+    SkipCommentTag(wxString::const_iterator& p, wxString::const_iterator end);
+

 protected:
     // DOM structure
     void CreateDOMTree();
     void DestroyDOMTree();
     void CreateDOMSubTree(wxHtmlTag *cur,
 protected:
     // DOM structure
     void CreateDOMTree();
     void DestroyDOMTree();
     void CreateDOMSubTree(wxHtmlTag *cur,

-                          int begin_pos, int end_pos,
+                          const wxString::const_iterator& begin_pos,
+                          const wxString::const_iterator& end_pos,

                           wxHtmlTagsCache *cache);
 
     // Adds text to the output.
     // This is called from Parse() and must be overriden in derived classes.
                           wxHtmlTagsCache *cache);
 
     // Adds text to the output.
     // This is called from Parse() and must be overriden in derived classes.

-    // txt is not guaranteed to be only one word. It is largest continuous part of text
-    // (= not broken by tags)
-    // NOTE : using char* because of speed improvements
-    virtual void AddText(const wxChar* txt) = 0;
+    // txt is not guaranteed to be only one word. It is largest continuous part
+    // of text (= not broken by tags)
+    virtual void AddText(const wxString& txt) = 0;

 
     // Adds tag and proceeds it. Parse() may (and usually is) called from this method.
     // This is called from Parse() and may be overriden.
 
     // Adds tag and proceeds it. Parse() may (and usually is) called from this method.
     // This is called from Parse() and may be overriden.


@@ -153,7 +175,7 @@ protected:
     wxHtmlTextPieces *m_TextPieces;
     size_t m_CurTextPiece;
 
     wxHtmlTextPieces *m_TextPieces;
     size_t m_CurTextPiece;
 

-    wxString m_Source;
+    const wxString *m_Source;

 
     wxHtmlParserState *m_SavedStates;
 
 
     wxHtmlParserState *m_SavedStates;
 


@@ -166,15 +188,15 @@ protected:
     //      it may (and often does) contain more references to one object
     // m_HandlersList is list of all handlers and it is guaranteed to contain
     //      only one reference to each handler instance.
     //      it may (and often does) contain more references to one object
     // m_HandlersList is list of all handlers and it is guaranteed to contain
     //      only one reference to each handler instance.

-    wxList m_HandlersList;
-    wxHashTable m_HandlersHash;
+    wxHtmlTagHandlersSet m_HandlersSet;
+    wxHtmlTagHandlersHash m_HandlersHash;

 
     DECLARE_NO_COPY_CLASS(wxHtmlParser)
 
     // class for opening files (file system)
     wxFileSystem *m_FS;
     // handlers stack used by PushTagHandler and PopTagHandler
 
     DECLARE_NO_COPY_CLASS(wxHtmlParser)
 
     // class for opening files (file system)
     wxFileSystem *m_FS;
     // handlers stack used by PushTagHandler and PopTagHandler

-    wxList *m_HandlersStack;
+    wxVector<wxHtmlTagHandlersHash*> m_HandlersStack;

 
     // entity parse
     wxHtmlEntitiesParser *m_entitiesParser;
 
     // entity parse
     wxHtmlEntitiesParser *m_entitiesParser;


@@ -189,7 +211,7 @@ protected:
 // Each recognized tag is passed to handler which is capable
 // of handling it. Each tag is handled in 3 steps:
 // 1. Handler will modifies state of parser
 // Each recognized tag is passed to handler which is capable
 // of handling it. Each tag is handled in 3 steps:
 // 1. Handler will modifies state of parser

-//    (using it's public methods)
+//    (using its public methods)

 // 2. Parser parses source between starting and ending tag
 // 3. Handler restores original state of the parser
 class WXDLLIMPEXP_HTML wxHtmlTagHandler : public wxObject
 // 2. Parser parses source between starting and ending tag
 // 3. Handler restores original state of the parser
 class WXDLLIMPEXP_HTML wxHtmlTagHandler : public wxObject


@@ -222,7 +244,13 @@ protected:
     // parses input between beginning and ending tag.
     // m_Parser must be set.
     void ParseInner(const wxHtmlTag& tag)
     // parses input between beginning and ending tag.
     // m_Parser must be set.
     void ParseInner(const wxHtmlTag& tag)

-        { m_Parser->DoParsing(tag.GetBeginPos(), tag.GetEndPos1()); }
+        { m_Parser->DoParsing(tag.GetBeginIter(), tag.GetEndIter1()); }
+
+    // Parses given source as if it was tag's inner code (see
+    // wxHtmlParser::GetInnerSource).  Unlike ParseInner(), this method lets
+    // you specify the source code to parse. This is useful when you need to
+    // modify the inner text before parsing.
+    void ParseInnerSource(const wxString& source);

 
     wxHtmlParser *m_Parser;
 
 
     wxHtmlParser *m_Parser;
 


@@ -246,16 +274,16 @@ public:
 
     // Parses entities in input and replaces them with respective characters
     // (with respect to output encoding)
 
     // Parses entities in input and replaces them with respective characters
     // (with respect to output encoding)

-    wxString Parse(const wxString& input);
+    wxString Parse(const wxString& input) const;

 
     // Returns character for given entity or 0 if the enity is unknown
 
     // Returns character for given entity or 0 if the enity is unknown

-    wxChar GetEntityChar(const wxString& entity);
+    wxChar GetEntityChar(const wxString& entity) const;

 
     // Returns character that represents given Unicode code
 #if wxUSE_UNICODE
 
     // Returns character that represents given Unicode code
 #if wxUSE_UNICODE

-    wxChar GetCharForCode(unsigned code) { return (wxChar)code; }
+    wxChar GetCharForCode(unsigned code) const { return (wxChar)code; }

 #else
 #else

-    wxChar GetCharForCode(unsigned code);
+    wxChar GetCharForCode(unsigned code) const;

 #endif
 
 protected:
 #endif
 
 protected: