1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef ADC_TKPCONTX_HXX 29*cdf0e10cSrcweir #define ADC_TKPCONTX_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir // USED SERVICES 32*cdf0e10cSrcweir // BASE CLASSES 33*cdf0e10cSrcweir // COMPONENTS 34*cdf0e10cSrcweir // PARAMETERS 35*cdf0e10cSrcweir #include <tokens/token.hxx> 36*cdf0e10cSrcweir class CharacterSource; 37*cdf0e10cSrcweir class TkpNullContext; 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir /** @task 40*cdf0e10cSrcweir Specifies a context within which tokens are interpreted in a special 41*cdf0e10cSrcweir way. For example in parsing C++ there could be a context for code, 42*cdf0e10cSrcweir one for comments and a third one for preprocessor statements, because 43*cdf0e10cSrcweir each of these would give the same token different meanings. 44*cdf0e10cSrcweir 45*cdf0e10cSrcweir The three functions 46*cdf0e10cSrcweir ReadCharChain() 47*cdf0e10cSrcweir PassNewToken() 48*cdf0e10cSrcweir FollowUpContext() 49*cdf0e10cSrcweir have to be called in this sequence. 50*cdf0e10cSrcweir 51*cdf0e10cSrcweir **/ 52*cdf0e10cSrcweir class TkpContext 53*cdf0e10cSrcweir { 54*cdf0e10cSrcweir public: 55*cdf0e10cSrcweir // LIFECYCLE 56*cdf0e10cSrcweir virtual ~TkpContext() {} 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir // OPERATIONS 59*cdf0e10cSrcweir /** @descr 60*cdf0e10cSrcweir The functions starts to parse with the CurChar() of io_rText. 61*cdf0e10cSrcweir It leaves io_rText.CurChar() at the first char of the following Token or 62*cdf0e10cSrcweir the following Context. 63*cdf0e10cSrcweir 64*cdf0e10cSrcweir This function returns, when a context has parsed some characterss 65*cdf0e10cSrcweir and completed a token OR left the context. 66*cdf0e10cSrcweir If the token is to be ignored, it is cut from io_rText. 67*cdf0e10cSrcweir 68*cdf0e10cSrcweir If the token is to be parsed further in a different context, 69*cdf0e10cSrcweir it is NOT cut from io_rText. 70*cdf0e10cSrcweir 71*cdf0e10cSrcweir After this function PassNewToken() has to be called. 72*cdf0e10cSrcweir 73*cdf0e10cSrcweir If the function has found a valid and complete token, PassNewToken() 74*cdf0e10cSrcweir passes the parsed token to the internally known receiver and 75*cdf0e10cSrcweir returns true. The token is cut from io_rText. 76*cdf0e10cSrcweir **/ 77*cdf0e10cSrcweir virtual void ReadCharChain( 78*cdf0e10cSrcweir CharacterSource & io_rText ) = 0; 79*cdf0e10cSrcweir /** Has to pass the parsed token to a known receiver. 80*cdf0e10cSrcweir If the token is to be parsed further in a different context, 81*cdf0e10cSrcweir PassNewToken() returns false, but the token is NOT cut from io_rText. 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir @return true, if a token was passed. 84*cdf0e10cSrcweir false, if the token was not parsed completely by this context 85*cdf0e10cSrcweir or if the token is to be ignored. 86*cdf0e10cSrcweir */ 87*cdf0e10cSrcweir virtual bool PassNewToken() = 0; 88*cdf0e10cSrcweir virtual TkpContext & 89*cdf0e10cSrcweir FollowUpContext() = 0; 90*cdf0e10cSrcweir 91*cdf0e10cSrcweir static TkpNullContext & 92*cdf0e10cSrcweir Null_(); 93*cdf0e10cSrcweir }; 94*cdf0e10cSrcweir 95*cdf0e10cSrcweir class StateMachineContext 96*cdf0e10cSrcweir { 97*cdf0e10cSrcweir public: 98*cdf0e10cSrcweir typedef TextToken::F_CRTOK F_CRTOK; 99*cdf0e10cSrcweir 100*cdf0e10cSrcweir virtual ~StateMachineContext() {} 101*cdf0e10cSrcweir 102*cdf0e10cSrcweir /// Is used by StmBoundsStatus only. 103*cdf0e10cSrcweir virtual void PerformStatusFunction( 104*cdf0e10cSrcweir uintt i_nStatusSignal, 105*cdf0e10cSrcweir F_CRTOK i_fTokenCreateFunction, 106*cdf0e10cSrcweir CharacterSource & io_rText ) = 0; 107*cdf0e10cSrcweir }; 108*cdf0e10cSrcweir 109*cdf0e10cSrcweir class TkpNullContext : public TkpContext 110*cdf0e10cSrcweir { 111*cdf0e10cSrcweir public: 112*cdf0e10cSrcweir ~TkpNullContext(); 113*cdf0e10cSrcweir 114*cdf0e10cSrcweir virtual void ReadCharChain( 115*cdf0e10cSrcweir CharacterSource & io_rText ); 116*cdf0e10cSrcweir virtual bool PassNewToken(); 117*cdf0e10cSrcweir virtual TkpContext & 118*cdf0e10cSrcweir FollowUpContext(); 119*cdf0e10cSrcweir }; 120*cdf0e10cSrcweir 121*cdf0e10cSrcweir namespace autodoc 122*cdf0e10cSrcweir { 123*cdf0e10cSrcweir 124*cdf0e10cSrcweir class TkpDocuContext : public TkpContext 125*cdf0e10cSrcweir { 126*cdf0e10cSrcweir public: 127*cdf0e10cSrcweir virtual void SetParentContext( 128*cdf0e10cSrcweir TkpContext & io_rParentContext, 129*cdf0e10cSrcweir const char * i_sMultiLineEndToken ) = 0; 130*cdf0e10cSrcweir virtual void AssignDealer( 131*cdf0e10cSrcweir TokenDealer & o_rDealer ) = 0; 132*cdf0e10cSrcweir virtual void SetMode_IsMultiLine( 133*cdf0e10cSrcweir bool i_bTrue ) = 0; 134*cdf0e10cSrcweir }; 135*cdf0e10cSrcweir 136*cdf0e10cSrcweir } // namespace autodoc 137*cdf0e10cSrcweir 138*cdf0e10cSrcweir #endif 139*cdf0e10cSrcweir 140*cdf0e10cSrcweir 141