xaizek / zograscope (License: AGPLv3 only) (since 2018-12-07)
Mainly a syntax-aware diff that also provides a number of additional tools.
<root> / src / tooling / Config.hpp (7cf3e125279e0d37b85ccb2db9f3035fb179b33f) (2,554B) (mode 100644) [raw]
// Copyright (C) 2021 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_TOOLING_CONFIG_HPP_
#define ZOGRASCOPE_TOOLING_CONFIG_HPP_

#include <boost/filesystem/path.hpp>

#include <string>
#include <utility>
#include <vector>

// Set of attribute for a path.
struct Attrs
{
    // Language to use, empty if unspecified.
    std::string lang;
    // Number of spaces in a full tabulation, -1 if unspecified.
    int tabWidth = -1;
};

// Encapsulates configuration information.
class Config
{
    class MatchExpr;

public:
    // Discovers configuration files and root by visiting parents of the
    // specified path.
    explicit Config(const boost::filesystem::path &currDir);

    // Destroys fields with full types.
    ~Config();

public:
    // Checks whether contents of specific directory should be looked at.
    bool shouldVisitDirectory(const std::string &path) const;
    // Checks whether specific file should be processed.
    bool shouldProcessFile(const std::string &path) const;

    // Retrieves attributes for a specific path.
    Attrs lookupAttrs(const std::string &path) const;

private:
    // Finds root directory (sets `rootDir`) and returns path to configuration
    // directory.  Both paths are empty if nothing was found.
    boost::filesystem::path discoverRoot();
    // Loads data from configuration directory.
    void loadConfigDir(const boost::filesystem::path &configDir);
    // Checks whether specific path should be processed.
    bool isAllowed(const std::string &path, bool isDir) const;

private:
    boost::filesystem::path rootDir; // Root for the configuration.
    boost::filesystem::path currDir; // Current directory for relative paths.

    // List of rules for file exclusion.
    std::vector<MatchExpr> excludeRules;
    // List of rules for attribute assignments.
    std::vector<std::pair<MatchExpr, Attrs>> attrRules;
};

#endif // ZOGRASCOPE_TOOLING_CONFIG_HPP_
Hints

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