File indexing completed on 2024-04-14 04:29:45

 /* This file is part of KDevelop
     Copyright 2006 Hamish Rodda <rodda@kde.org>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2 as published by the Free Software Foundation.
 
    This library 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
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
 */
 
 #ifndef CSSEDITORINTEGRATOR_H
 #define CSSEDITORINTEGRATOR_H
 
 #include <language/editor/rangeinrevision.h>
 
 #include "parserexport.h"
 #include "kdev-pg-token-stream.h"
 
 namespace Css
 {
 
 class ParseSession;
 struct AstNode;
 
 
 /**
  * Provides facilities for easy integration of a text editor component with
  * the information parsed from a source file.
  *
  * Uses a disguised singleton + stateful design.
  *
  * \todo introduce stacks for the state?
  */
 class KDEVCSSPARSER_EXPORT EditorIntegrator
 {
 public:
     enum Edge {
         FrontEdge,
         BackEdge
     };
 
     enum RangeEdge {
         InnerEdge,
         OuterEdge
     };
 
     EditorIntegrator();
     void setParseSession(ParseSession* session);
     ParseSession* parseSession() const;
 
     /**
      * Finds the location and \a file where the given \a token was parsed from.  This function
      * does not change any of the EditorIntegrator's state.
      *
      * \param token token to locate
      * \param edge set to FrontEdge to return the start position of the token, BackEdge to return the end position.
      *
      * \returns the requested cursor relating to the start or end of the given token.
      */
     KDevelop::CursorInRevision findPosition(const KDevPG::TokenStream::Token& token, Edge edge = BackEdge) const;
 
     /**
      * Finds the location and \a file where the given \a token was parsed from.
      * This function does not change any of the EditorIntegrator's state.
      *
      * \param token token to locate
      * \param edge set to FrontEdge to return the start position of the token, BackEdge to return the end position.
      *
      * \returns the requested cursor relating to the start or end of the given token.
      */
     KDevelop::CursorInRevision findPosition(qint64 token, Edge edge = BackEdge) const;
 
     /**
      * Create a range encompassing the given AstNode \a node.
      * This function does not change any of the EditorIntegrator's state.
      *
      * \overload
      */
     KDevelop::RangeInRevision findRange(AstNode* node, RangeEdge = OuterEdge);
 
     /**
      * Create a range encompassing the given AstNode \a nodes.
      * This function does not change any of the EditorIntegrator's state.
      *
      * \overload
      */
     KDevelop::RangeInRevision findRange(AstNode* from, AstNode* to);
 
     /**
      * Create a range encompassing the given AstNode \a token.
      * This function does not change any of the EditorIntegrator's state.
      *
      * \overload
      */
     KDevelop::RangeInRevision findRange(const KDevPG::TokenStream::Token& token);
 
     /**
      * Create a range encompassing the given AstNode \a token.
      * This function does not change any of the EditorIntegrator's state.
      *
      * \overload
      */
     KDevelop::RangeInRevision findRange(qint64 token);
 
     /**
      * Create a range encompassing the given AstNode \a tokens.
      * This function does not change any of the EditorIntegrator's state.
      *
      * \overload
      */
     KDevelop::RangeInRevision findRange(qint64 start_token, qint64 end_token);
 
     /**
      * Retrieve the string represented by a token.
      */
     QString tokenToString(qint64 token) const;
     QString nodeToString(AstNode *node) const;
 
 private:
     ParseSession* m_session;
 };
 
 }
 
 #endif // PHPEDITORINTEGRATOR_H