Source: tohtml.h

# Source: tohtml.h |
Annotated List
Files
Globals
Hierarchy
Index

    /*****
     *
     * TOra - An Oracle Toolkit for DBA's and developers
     * Copyright (C) 2003-2005 Quest Software, Inc
     * Portions Copyright (C) 2005 Other Contributors
     *
     * This program is free software; you can redistribute it and/or
     * modify it under the terms of the GNU General Public License
     * as published by the Free Software Foundation;  only version 2 of
     * the License is valid for this program.
     *
     * This program is distributed in the hope that it will be useful,
     * but WITHOUT ANY WARRANTY; without even the implied warranty of
     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     * GNU General Public License for more details.
     *
     * You should have received a copy of the GNU General Public License
     * along with this program; if not, write to the Free Software
     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
     *
     *      As a special exception, you have permission to link this program
     *      with the Oracle Client libraries and distribute executables, as long
     *      as you follow the requirements of the GNU GPL in regard to all of the
     *      software in the executable aside from Oracle client libraries.
     *
     *      Specifically you are not permitted to link this program with the
     *      Qt/UNIX, Qt/Windows or Qt Non Commercial products of TrollTech.
     *      And you are not permitted to distribute binaries compiled against
     *      these libraries without written consent from Quest Software, Inc.
     *      Observe that this does not disallow linking to the Qt Free Edition.
     *
     *      You may link this product with any GPL'd Qt library such as Qt/Free
     *
     * All trademarks belong to their respective owners.
     *
     *****/

    #ifndef TOHTML_H
    #define TOHTML_H

    #include

    #include
    #include

    #define TO_HTML_MAX_QUAL 100

    /** A small and hopefully pretty efficient parser of HTML tags. No attempt what
     * so ever is made trying to check the validity of the text so if you forget
     * a closing > you will probably end up with an exception.
     *
     * A simple traverser counting the number of paragraphs might look like this.
     *

    int paragraphs++;
    toHtml count("ParagraphsAnd someDobedoo");
    while(!count.eof()) {
      count.nextToken();
      if (count.isTag()&&count.open()&&QString(count.tag())=="p")
        paragraphs++;
    }

     */

    class toHtml {
      /** Actual data of file.
       */
      char *Data;
      /** Length of the data.
       */
      size_t Length;
      /** Current position in data.
       */
      size_t Position;

      /** Last character that was at the end of text written over by call to @ref mid.
       * This is a real cludge, but what don't you do for performance.
       */
      char LastChar;

      /** List of qualifiers for tab. This is not a list because of performance as well.
       * Not really a lot of memory wasted this way, in fact it is probably more efficient
       * than a dynamic list.
       */
      struct {
        /** Name of qualifier. Always lowercase, points into @ref Data.
         */
        const char *Name;
        /** Value of qualifier. Points into @ref Data.
         */
        const char *Value;
      } Qualifiers[TO_HTML_MAX_QUAL];

      /** Number of qualifiers used.
       */
      int QualifierNum;
      /** If last token read was a tag or plain text.
       */
      bool IsTag;
      /** Last tag read was an open tag. Only valid if @ref isTag is true.
       */
      bool Open;
      /** Name of tag. NULL terminated, points into @ref Data.
       */
      const char *Tag;
      /** Text if not tag. NULL terminated, points into @ref Data.
       */
      const char *Text;

      /** Walk forward in @ref Data until not whitespace.
       */
      void skipSpace(void);
      /** Extract a string from @ref Data. Insert 0 at end of string, store overwritten char
       * in LastChar.
       * @param start Start position of string to extract.
       * @param size Size of string to extract.
       * @return Pointer to string (Points into @ref Data)
       */
      const char *mid(size_t start,size_t size);
    public:
      /** Create a HTML parser.
       * @param data Data to parse.
       */
      toHtml(const QCString &data);
      ~toHtml();

      /** Read the next token which can be either a open tag, close tag or text.
       *
       * Observe that nextToken destroys the data it has parsed, so you
       * can't search it later. Searhing must be done on an new toHtml,
       * several serches can be made though on the same toHtml.
       */

      void nextToken(void);

      /** Get value of a qualifier.
       * @param name Name of qualifier in lowercase.
       * @return Value of qualifier or NULL.
       */
      const char *value(const QCString &name);
      /** Return true if current token is a tag.
       * @return True if tag.
       */
      bool isTag(void)
      { return IsTag; }
      /** Return true if open tag. Only valid if @ref isTag is true.
       * @return True if open tag.
       */
      bool open(void)
      { return Open; }

      /** Get bread text if available. Expands &# characters are expanded before returned.
       * Only valid if @ref isTag returns false.
       * @return The parsed text.
       */

      QCString text(void);

      /** Get name of tag in lowercase. Only valid if @ref isTag returns true.
       * @return Name of tag (Excluding / if close tag).
       */
      const char *tag(void)
      { return Tag; }

      /** Check if at end of data
       * @return True if at end of data.
       */
      bool eof(void);

      /** Search data for a simple text.
       * @param data Data to search.
       * @param str Substring to search for in data.
       */
      static bool search(const QCString &data,const QString &str);

      /** Escape text to be HTML.
       */
      static QString escape(const QString &html);
    };

    #endif

Generated by: nneul on skyhawk on Wed Feb 23 19:49:58 2005, using kdoc 2.0a54.