// Copyright (C) 2017 xaizek <xaizek@posteo.net>
//
// This file is part of zograscope.
//
// zograscope is free software: you can redistribute it and/or modify
// it under the terms of version 3 of the GNU Affero General Public License as
// published by the Free Software Foundation.
//
// zograscope 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with zograscope. If not, see <http://www.gnu.org/licenses/>.
#ifndef ZOGRASCOPE_LANGUAGE_HPP_
#define ZOGRASCOPE_LANGUAGE_HPP_
#include <cstdint>
#include <memory>
#include <string>
namespace cpp17 {
namespace pmr {
class monolithic;
}
}
class Node;
class TreeBuilder;
enum class MType : std::uint8_t;
enum class SType : std::uint8_t;
enum class Type : std::uint8_t;
// Language-specific routines.
class Language
{
public:
// Determines and creates language based on file name. Non-empty `lang`
// parameter forces specific language ("c" or "make"). Throws
// `std::runtime_error` on incorrect language name.
static std::unique_ptr<Language> create(const std::string &fileName,
const std::string &lang = {});
// Checks whether file matches given language. When `lang` is an empty
// string any of supported languages is considered a match.
static bool matches(const std::string &fileName, const std::string &lang);
// Checks whether two language ids are equal.
static bool equal(const std::string &langA, const std::string &langB);
public:
// Virtual destructor for a base class.
virtual ~Language() = default;
public:
// Maps language-specific token to an element of Type enumeration.
virtual Type mapToken(int token) const = 0;
// Parses source file into a tree.
virtual TreeBuilder parse(const std::string &contents,
const std::string &fileName,
int tabWidth,
bool debug,
cpp17::pmr::monolithic &mr) const = 0;
// Checks whether node doesn't have fixed position within a tree and can
// move between internal nodes as long as post-order of leafs is preserved.
virtual bool isTravellingNode(const Node *x) const = 0;
// Checks whether the node enforces fixed structure (fixed number of
// children at particular places).
virtual bool hasFixedStructure(const Node *x) const = 0;
// Checks whether a node can be flattened on a specific level of flattening.
virtual bool canBeFlattened(const Node *parent, const Node *child,
int level) const = 0;
// Checks whether a node should be considered for a move.
virtual bool isUnmovable(const Node *x) const = 0;
// Checks whether a node is a container.
virtual bool isContainer(const Node *x) const = 0;
// Checks whether spelling of a node can be diffed.
virtual bool isDiffable(const Node *x) const = 0;
// Checks whether a node represents a structural (auxiliary, like braces)
// token.
virtual bool isStructural(const Node *x) const = 0;
// Checks whether a node represents a token used to declare line
// continuation.
virtual bool isEolContinuation(const Node *x) const = 0;
// Checks whether a node always matches another node with the same stype.
virtual bool alwaysMatches(const Node *x) const = 0;
// Checks whether parameter node (as reported by `classify()`) represents a
// true parameter and not something like "no argument list".
virtual bool isPseudoParameter(const Node *x) const = 0;
// Checks whether child node needs to be replaced in its parent with its
// children.
virtual bool shouldSplice(SType parent, const Node *childNode) const = 0;
// Checks whether the type corresponds to a value node.
virtual bool isValueNode(SType stype) const = 0;
// Checks whether this node with its descendants should be placed one level
// deeper.
virtual bool isLayerBreak(SType parent, SType stype) const = 0;
// Checks whether leading space in spelling of nodes of this kind should be
// skipped for the purposes of comparison.
virtual bool shouldDropLeadingWS(SType stype) const = 0;
// Checks whether nodes of this kind are secondary for comparison.
virtual bool isSatellite(SType stype) const = 0;
// Maps language-specific stype to generic mtype.
virtual MType classify(SType stype) const = 0;
// Stringifies value of SType enumeration.
virtual const char * toString(SType stype) const = 0;
// For children of nodes with fixed structure this checks whether this child
// is first-class member of the structure or not (e.g., not punctuation).
bool isPayloadOfFixed(const Node *x) const;
// Checks whether children of the node can be considered for a move.
bool hasMoveableItems(const Node *x) const;
};
#endif // ZOGRASCOPE_LANGUAGE_HPP_
Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"
Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/zograscope
Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/zograscope
You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a
pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master