Fixing font utilities

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

diff --git a/include/wx/html/htmlpars.h b/include/wx/html/htmlpars.h
index 272c44ad5efe0878f89f8134ad194eb245e527f8..0faf78d4ddcb16efbd414b5892da8e6470a8199a 100644 (file)
--- a/include/wx/html/htmlpars.h
+++ b/include/wx/html/htmlpars.h
@@ -12,7 +12,7 @@
 #define _WX_HTMLPARS_H_
 
 #ifdef __GNUG__
 #define _WX_HTMLPARS_H_
 
 #ifdef __GNUG__

-#pragma interface
+#pragma interface "htmlpars.h"

 #endif
 
 #include "wx/defs.h"
 #endif
 
 #include "wx/defs.h"


@@ -20,25 +20,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/fontenc.h"

 
 

-class wxHtmlParser;
-class wxHtmlTagHandler;
+class WXDLLEXPORT wxMBConv;
+class WXDLLEXPORT wxHtmlParser;
+class WXDLLEXPORT wxHtmlTagHandler;
+class WXDLLEXPORT wxHtmlEntitiesParser;

 
 

-//--------------------------------------------------------------------------------
-// wxHtmlParser
-//                  This class handles generic parsing of HTML document : it scans
-//                  the document and divide it into blocks of tags (where one block
-//                  consists of starting and ending tag and of text between these
-//                  2 tags.
-//--------------------------------------------------------------------------------
+class wxHtmlTextPieces;
+class wxHtmlParserState;

 
 

+// This class handles generic parsing of HTML document : it scans
+// the document and divide it into blocks of tags (where one block
+// consists of starting and ending tag and of text between these
+// 2 tags.

 class WXDLLEXPORT wxHtmlParser : public wxObject
 {
     DECLARE_ABSTRACT_CLASS(wxHtmlParser)
 
 public:
 class WXDLLEXPORT wxHtmlParser : public wxObject
 {
     DECLARE_ABSTRACT_CLASS(wxHtmlParser)
 
 public:

-    wxHtmlParser() : wxObject(), m_HandlersHash(wxKEY_STRING) 
-        { m_FS = NULL; m_Cache = NULL; m_HandlersStack = NULL; }
+    wxHtmlParser();

     virtual ~wxHtmlParser();
 
     // Sets the class which will be used for opening files
     virtual ~wxHtmlParser();
 
     // Sets the class which will be used for opening files


@@ -46,6 +48,10 @@ public:
 
     wxFileSystem* GetFS() const { return m_FS; }
 
 
     wxFileSystem* GetFS() const { return m_FS; }
 

+    // Returns TRUE if the parser is allowed to open given URL (may be forbidden
+    // for security reasons)    
+    virtual bool CanOpenURL(const wxString& url) const { return TRUE; }
+

     // You can simply call this method when you need parsed output.
     // This method does these things:
     // 1. call InitParser(source);
     // You can simply call this method when you need parsed output.
     // This method does these things:
     // 1. call InitParser(source);


@@ -62,7 +68,10 @@ public:
     // 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);
     // 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);

-    inline void DoParsing() {DoParsing(0, m_Source.Length());};
+    void DoParsing();
+
+    // Returns pointer to the tag at parser's current position
+    wxHtmlTag *GetCurrentTag() const { return m_CurTag; }

 
     // Returns product of parsing
     // Returned value is result of parsing of the part. The type of this result
 
     // Returns product of parsing
     // Returned value is result of parsing of the part. The type of this result


@@ -91,14 +100,30 @@ public:
 
     wxString* GetSource() {return &m_Source;}
     void SetSource(const wxString& src);
 
     wxString* GetSource() {return &m_Source;}
     void SetSource(const wxString& src);

+    
+    // Sets HTML source and remebers 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>)
+    virtual void SetSourceAndSaveState(const wxString& src);
+    // Restores parser's state from stack or returns FALSE if the stack is
+    // empty
+    virtual bool RestoreState();

 
 protected:
 
 protected:

+    // DOM structure
+    void CreateDOMTree();
+    void DestroyDOMTree();
+    void CreateDOMSubTree(wxHtmlTag *cur,
+                          int begin_pos, int end_pos, 
+                          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
     // 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 char* txt) = 0;
+    virtual void AddText(const wxChar* 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.


@@ -106,15 +131,21 @@ protected:
     // ignored if no hander is found.
     // Derived class is *responsible* for filling in m_Handlers table.
     virtual void AddTag(const wxHtmlTag& tag);
     // ignored if no hander is found.
     // Derived class is *responsible* for filling in m_Handlers table.
     virtual void AddTag(const wxHtmlTag& tag);

+    
+    // Returns entity parser object, used to substitute HTML &entities;
+    wxHtmlEntitiesParser *GetEntitiesParser() const { return m_entitiesParser; }

 
 protected:
 
 protected:

-    // source being parsed
-    wxString m_Source;
-
-    // tags cache, used during parsing.
-    wxHtmlTagsCache *m_Cache;
-    wxHashTable m_HandlersHash;
+    // DOM tree:
+    wxHtmlTag *m_CurTag;
+    wxHtmlTag *m_Tags;
+    wxHtmlTextPieces *m_TextPieces;
+    size_t m_CurTextPiece;

 
 

+    wxString m_Source;
+    
+    wxHtmlParserState *m_SavedStates;
+    

     // handlers that handle particular tags. The table is accessed by
     // key = tag's name.
     // This attribute MUST be filled by derived class otherwise it would
     // handlers that handle particular tags. The table is accessed by
     // key = tag's name.
     // This attribute MUST be filled by derived class otherwise it would


@@ -125,29 +156,26 @@ protected:
     // m_HandlersList is list of all handlers and it is guaranteed to contain
     //      only one reference to each handler instance.
     wxList m_HandlersList;
     // 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;

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

+    
+    // entity parse
+    wxHtmlEntitiesParser *m_entitiesParser;

 };
 
 
 
 };
 
 
 

-
-
-
-//--------------------------------------------------------------------------------
-// wxHtmlTagHandler
-//                  This class (and derived classes) cooperates with wxHtmlParser.
-//                  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)
-//                  2. Parser parses source between starting and ending tag
-//                  3. Handler restores original state of the parser
-//--------------------------------------------------------------------------------
-
+// This class (and derived classes) cooperates with wxHtmlParser.
+// 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)
+// 2. Parser parses source between starting and ending tag
+// 3. Handler restores original state of the parser

 class WXDLLEXPORT wxHtmlTagHandler : public wxObject
 {
     DECLARE_ABSTRACT_CLASS(wxHtmlTagHandler)
 class WXDLLEXPORT wxHtmlTagHandler : public wxObject
 {
     DECLARE_ABSTRACT_CLASS(wxHtmlTagHandler)


@@ -184,6 +212,36 @@ protected:
 };
 
 
 };
 
 

+// This class is used to parse HTML entities in strings. It can handle
+// both named entities and &#xxxx entries where xxxx is Unicode code.
+class WXDLLEXPORT wxHtmlEntitiesParser : public wxObject
+{
+    DECLARE_DYNAMIC_CLASS(wxHtmlEntitiesParser)
+
+public:
+    wxHtmlEntitiesParser();
+    virtual ~wxHtmlEntitiesParser();
+    
+    // Sets encoding of output string.
+    // Has no effect if wxUSE_WCHAR_T==0 or wxUSE_UNICODE==1
+    void SetEncoding(wxFontEncoding encoding);
+    
+    // Parses entities in input and replaces them with respective characters
+    // (with respect to output encoding)
+    wxString Parse(const wxString& input);
+
+    // Returns character for given entity or 0 if the enity is unknown
+    wxChar GetEntityChar(const wxString& entity);
+
+    // Returns character that represents given Unicode code
+    wxChar GetCharForCode(unsigned code);
+
+protected:
+#if wxUSE_WCHAR_T && !wxUSE_UNICODE
+    wxMBConv *m_conv;
+    wxFontEncoding m_encoding;
+#endif
+};

 
 
 #endif
 
 
 #endif