CHMLFiltTokenisor.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Developer Technologies
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef _CHMLFiltTokenisor_H_
#define _CHMLFiltTokenisor_H_


typedef PMString TokenValue;


enum Token_t
{
 kTokenInvalid, 
 kTokenEOF,
 
 kTokenHead, 
 kTokenText, 
 kTokenSize, 
 kTokenBold, 
 kTokenNoBold, 
 kTokenUnderline, 
 kTokenNoUnderline, 
 kTokenFont, 
 kTokenPara, 
 kTokenIFile, 
 kTokenTbox, 
 kTokenAlign, 
 kTokenCommentStart, 
 kTokenCommentEnd, 
 // additional tokens for CJK features (not recognised in main import provider, Apr 2003: IRP)
 kTokenKenten, 
 kTokenNoKenten,
 kTokenSyatai, 
 kTokenNoSyatai,
 kTokenRuby
};

// string equivalents of the token typess of (see enum Token_t above)
#define TOKENHEAD PMString("<CHML>")
#define TOKENSIZE PMString("<s ")
#define TOKENSTARTBOLD PMString("<b>")
#define TOKENENDBOLD PMString("</b>")
#define TOKENSTARTUNDERLINE PMString("<u>")
#define TOKENENDUNDERLINE PMString("</u>")
#define TOKENFONT PMString("<f ")
#define TOKENPARA PMString("<p>")
#define TOKENIFILE PMString ("<i ")
#define TOKENTBOX PMString("<t ")
#define TOKENALIGN PMString("<a ")
#define TOKENSTARTCOMMENT PMString("<c>")
#define TOKENENDCOMMENT PMString("</c>")
// Additional Japanese specific tokens
#define TOKENKENTEN PMString("<k>")
#define TOKENENDKENTEN PMString("</k>")
#define TOKENSYATAI PMString("<q>")
#define TOKENENDSYATAI PMString("</q>")
#define TOKENRUBY PMString("<r ")


class CHMLFiltTokenisor
{
public:
 CHMLFiltTokenisor(IPMStream* s);
 
 ~CHMLFiltTokenisor(void);
 
 Token_t GetNextToken(TokenValue& theToken);

 Token_t GetCurrentToken(TokenValue& theToken);

 void ResetStream(void);

 void PushTokenBack(void); 

private:
 // we maintain the current token, this is what we pass back to the caller
 // of GetNextToken. Ownership remains with this class. 
 // We also maintain the current token type. This is in line with
 // the idea of a "global" current token used within compiler technologies.
 TokenValue fCurrentToken; 
 Token_t fCurrentTokenType;

 // we need to be able to push a token back onto the stream
 bool token_spare; 
 
 // the stream we are acting on
 IPMStream* theStream;
};

#endif //_CHMLFiltTokenisor_H_


// End, CHMLFiltTokenisor.h.