include/comphelper/syntaxhighlight.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_COMPHELPER_SYNTAXHIGHLIGHT_HXX
  20 #define INCLUDED_COMPHELPER_SYNTAXHIGHLIGHT_HXX
  21
  22 #include <rtl/ustring.hxx>
  23
  24 #include <comphelper/comphelperdllapi.h>
  25
  26 #include <vector>
  27 #include <memory>
  28
  29 enum class TokenType
  30 {
  31     Unknown,
  32     Identifier,
  33     Whitespace,
  34     Number,
  35     String,
  36     EOL,
  37     Comment,
  38     Error,
  39     Operator,
  40     Keywords,
  41     Parameter,
  42     LAST = Parameter
  43 };
  44
  45 struct HighlightPortion {
  46     sal_Int32 nBegin;
  47     sal_Int32 nEnd;
  48     TokenType tokenType;
  49
  50     HighlightPortion(
  51         sal_Int32 theBegin, sal_Int32 theEnd, TokenType theTokenType):
  52         nBegin(theBegin), nEnd(theEnd), tokenType(theTokenType)
  53     {}
  54 };
  55
  56 // Language mode of the Highlighter (possibly to be refined later with keyword
  57 // lists, C comment flags)
  58 enum class HighlighterLanguage
  59 {
  60     Basic,
  61     SQL
  62 };
  63
  64 class COMPHELPER_DLLPUBLIC SyntaxHighlighter
  65 {
  66     class Tokenizer;
  67
  68     std::unique_ptr<Tokenizer> m_tokenizer;
  69
  70     SyntaxHighlighter(const SyntaxHighlighter&) = delete;
  71     SyntaxHighlighter& operator=(const SyntaxHighlighter&) = delete;
  72 public:
  73     SyntaxHighlighter(HighlighterLanguage language);
  74     ~SyntaxHighlighter();
  75
  76     void getHighlightPortions( std::u16string_view rLine,
  77                                std::vector<HighlightPortion>& pPortions ) const;
  78
  79     HighlighterLanguage GetLanguage() const;
  80 };
  81
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */