diff options
Diffstat (limited to 'autodoc/source/parser/inc/tokens/tkpcontx.hxx')
| -rw-r--r-- | autodoc/source/parser/inc/tokens/tkpcontx.hxx | 142 |
1 files changed, 0 insertions, 142 deletions
diff --git a/autodoc/source/parser/inc/tokens/tkpcontx.hxx b/autodoc/source/parser/inc/tokens/tkpcontx.hxx deleted file mode 100644 index d838cbe2..00000000 --- a/autodoc/source/parser/inc/tokens/tkpcontx.hxx +++ /dev/null @@ -1,142 +0,0 @@ -/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org 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 Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ - -#ifndef ADC_TKPCONTX_HXX -#define ADC_TKPCONTX_HXX - -// USED SERVICES - // BASE CLASSES - // COMPONENTS - // PARAMETERS -#include <tokens/token.hxx> -class CharacterSource; -class TkpNullContext; - -/** @task - Specifies a context within which tokens are interpreted in a special - way. For example in parsing C++ there could be a context for code, - one for comments and a third one for preprocessor statements, because - each of these would give the same token different meanings. - - The three functions - ReadCharChain() - PassNewToken() - FollowUpContext() - have to be called in this sequence. - -**/ -class TkpContext -{ - public: - // LIFECYCLE - virtual ~TkpContext() {} - - // OPERATIONS - /** @descr - The functions starts to parse with the CurChar() of io_rText. - It leaves io_rText.CurChar() at the first char of the following Token or - the following Context. - - This function returns, when a context has parsed some characterss - and completed a token OR left the context. - If the token is to be ignored, it is cut from io_rText. - - If the token is to be parsed further in a different context, - it is NOT cut from io_rText. - - After this function PassNewToken() has to be called. - - If the function has found a valid and complete token, PassNewToken() - passes the parsed token to the internally known receiver and - returns true. The token is cut from io_rText. - **/ - virtual void ReadCharChain( - CharacterSource & io_rText ) = 0; - /** Has to pass the parsed token to a known receiver. - If the token is to be parsed further in a different context, - PassNewToken() returns false, but the token is NOT cut from io_rText. - - @return true, if a token was passed. - false, if the token was not parsed completely by this context - or if the token is to be ignored. - */ - virtual bool PassNewToken() = 0; - virtual TkpContext & - FollowUpContext() = 0; - - static TkpNullContext & - Null_(); -}; - -class StateMachineContext -{ - public: - typedef TextToken::F_CRTOK F_CRTOK; - - virtual ~StateMachineContext() {} - - /// Is used by StmBoundsStatus only. - virtual void PerformStatusFunction( - uintt i_nStatusSignal, - F_CRTOK i_fTokenCreateFunction, - CharacterSource & io_rText ) = 0; -}; - -class TkpNullContext : public TkpContext -{ - public: - ~TkpNullContext(); - - virtual void ReadCharChain( - CharacterSource & io_rText ); - virtual bool PassNewToken(); - virtual TkpContext & - FollowUpContext(); -}; - -namespace autodoc -{ - -class TkpDocuContext : public TkpContext -{ - public: - virtual void SetParentContext( - TkpContext & io_rParentContext, - const char * i_sMultiLineEndToken ) = 0; - virtual void AssignDealer( - TokenDealer & o_rDealer ) = 0; - virtual void SetMode_IsMultiLine( - bool i_bTrue ) = 0; -}; - -} // namespace autodoc - -#endif - - -/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |