Back to index

lightning-sunbird  0.9+nobinonly
nsTXTToHTMLConv.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef ____nstxttohtmlconv___h___
00039 #define ____nstxttohtmlconv___h___
00040 
00041 #include "nsITXTToHTMLConv.h"
00042 #include "nsCOMPtr.h"
00043 #include "nsVoidArray.h"
00044 #include "nsIFactory.h"
00045 #include "nsString.h"
00046 
00047 #define NS_NSTXTTOHTMLCONVERTER_CID                         \
00048 { /* 9ef9fa14-1dd1-11b2-9d65-d72d6d1f025e */ \
00049     0x9ef9fa14, \
00050     0x1dd1, \
00051     0x11b2, \
00052     {0x9d, 0x65, 0xd7, 0x2d, 0x6d, 0x1f, 0x02, 0x5e} \
00053 }
00054 
00055 // Internal representation of a "token"
00056 typedef struct convToken {
00057     nsString token;     // the actual string (i.e. "http://")
00058     nsString modText;   // replacement text or href prepend text.
00059     PRBool   prepend;   // flag indicating how the modText should be used.
00060 } convToken;
00061     
00090 class nsTXTToHTMLConv : public nsITXTToHTMLConv {
00091 public:
00092     NS_DECL_ISUPPORTS
00093     NS_DECL_NSISTREAMCONVERTER
00094     NS_DECL_NSITXTTOHTMLCONV
00095     NS_DECL_NSIREQUESTOBSERVER
00096     NS_DECL_NSISTREAMLISTENER
00097 
00098     nsTXTToHTMLConv();
00099     virtual ~nsTXTToHTMLConv();
00100     nsresult Init();
00101 
00102     // For factory creation.
00103     static NS_METHOD
00104     Create(nsISupports *aOuter, REFNSIID aIID, void **aResult) {
00105         nsresult rv;
00106         if (aOuter)
00107             return NS_ERROR_NO_AGGREGATION;
00108 
00109         nsTXTToHTMLConv* _s = new nsTXTToHTMLConv();
00110         if (_s == nsnull)
00111             return NS_ERROR_OUT_OF_MEMORY;
00112         NS_ADDREF(_s);
00113         rv = _s->Init();
00114         if (NS_FAILED(rv)) {
00115             delete _s;
00116             return rv;
00117         }
00118         rv = _s->QueryInterface(aIID, aResult);
00119         NS_RELEASE(_s);
00120         return rv;
00121     }
00122 
00123 
00124 protected:
00125     // return the token and it's location in the underlying buffer.
00126     PRInt32 FindToken(PRInt32 cursor, convToken* *_retval);
00127 
00128     // return the cursor location after munging HTML into the 
00129     // underlying buffer, according to mToken
00130     PRInt32 CatHTML(PRInt32 front, PRInt32 back);
00131 
00132     nsCOMPtr<nsIStreamListener>     mListener; // final listener (consumer)
00133     nsString                        mBuffer;   // any carry over data
00134     nsVoidArray                     mTokens;   // list of tokens to search for
00135     convToken                       *mToken;   // current token (if any)
00136     nsString                        mPageTitle; // Page title
00137     PRBool                          mPreFormatHTML; // Whether to use <pre> tags
00138 };
00139 
00140 #endif // ____nstxttohtmlconv___h___
00141