/usr/include/KF5/KSyntaxHighlighting/foldingregion.h is in libkf5syntaxhighlighting-dev 5.28.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 | /*
Copyright (C) 2016 Volker Krause <vkrause@kde.org>
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This program 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 General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef KSYNTAXHIGHLIGHTING_FOLDINGREGION_H
#define KSYNTAXHIGHLIGHTING_FOLDINGREGION_H
#include "ksyntaxhighlighting_export.h"
#include <QTypeInfo>
namespace KSyntaxHighlighting {
/** Represents a begin or end of a folding region. */
class KSYNTAXHIGHLIGHTING_EXPORT FoldingRegion
{
public:
/**
* Defines whether a FoldingRegion starts or ends a folding region.
*/
enum Type {
//! Used internally as indicator for invalid FoldingRegion%s.
None,
//! Indicates the start of a FoldingRegion.
Begin,
//! Indicates the end of a FoldingRegion.
End
};
/**
* Constructs an invalid folding region, meaning that isValid() returns @e false.
* To obtain valid instances, see AbstractHighlighter::applyFolding().
*/
FoldingRegion();
/** Compares two FoldingRegion instances for equality. */
bool operator==(const FoldingRegion &other) const;
/**
* Returns @c true if this is a valid folding region.
* A valid FoldingRegion is defined by a type() other than Type::None.
*
* @note The FoldingRegion%s passed in AbstractHighlighter::applyFolding()
* are always valid.
*/
bool isValid() const;
/**
* Returns a unique identifier for this folding region.
*
* As example, the C/C++ highlighter starts and ends a folding region for
* scopes, e.g.:
* \code
* void foo() { // '{' starts a folding region
* if (bar()) { // '{' starts a (nested) folding region
* } // '}' ends the (nested) folding region
* } // '}' ends the outer folding region
* \endcode
* In this example, all braces '{' and '}' have the same id(), meaning that
* if you want to find the matching closing region for the first opening
* brace, you need to do kind of a reference counting to find the correct
* closing brace.
*/
quint16 id() const;
/**
* Returns whether this is the begin or end of a region.
*
* @note The FoldingRegion%s passed in AbstractHighlighter::applyFolding()
* are always valid, i.e. either Type::Begin or Type::End.
*/
Type type() const;
private:
friend class Rule;
FoldingRegion(Type type, quint16 id);
quint16 m_type : 2;
quint16 m_id: 14;
};
}
Q_DECLARE_TYPEINFO(KSyntaxHighlighting::FoldingRegion, Q_PRIMITIVE_TYPE);
#endif
|