generatorbase.h - mozsearch

// Copyright (C) 2022 The Qt Company Ltd.

// Copyright (C) 2019 Alexey Edelev <semlanik@gmail.com>

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#ifndef GENERATORBASE_H

#define GENERATORBASE_H

#include <google/protobuf/compiler/code_generator.h>

#include "qtprotocdefs.h"

#include "utils.h"

#include <map>

#include <string>

namespace google::protobuf {

class FileDescriptor;

class Descriptor;

namespace compiler {

class GeneratorContext;

} // namespace compiler

namespace io {

class Printer;

} // namespace io

} // namespace google::protobuf

namespace qtprotoccommon {

class GeneratorBase : public ::google::protobuf::compiler::CodeGenerator

    GeneratorBase(const GeneratorBase &) = delete;

    GeneratorBase &operator=(const GeneratorBase &) = delete;

    GeneratorBase(GeneratorBase &&) = delete;

    GeneratorBase &operator=(GeneratorBase &&) = delete;

public:

    GeneratorBase() = default;

    ~GeneratorBase() = default;

    bool GenerateAll(const std::vector<const ::google::protobuf::FileDescriptor *> &files,

                     const std::string &parameter,

                     ::google::protobuf::compiler::GeneratorContext *generatorContext,

                     std::string *error) const override;

    bool HasGenerateAll() const override { return true; }

// TODO: This suppresses the build issue with old protobuf versions. Since we don't have the

// strict protobuf versions that we support this work around will be here for a while, since

// yocto builds quite old protobuf by now. See QTBUG-115702.

#ifndef HAVE_PROTOBUF_SYNC_PIPER

    uint64_t GetSupportedFeatures() const { return 0; };

#else

    uint64_t GetSupportedFeatures() const override

        return CodeGenerator::Feature::FEATURE_PROTO3_OPTIONAL;

#endif

    static void printDisclaimer(::google::protobuf::io::Printer *printer);

    static void printIncludes(google::protobuf::io::Printer *printer,

                              const std::set<std::string> &internal,

                              const utils::ExternalIncludesOrderedSet &external,

                              const std::set<std::string> &system);

    static void printHeaderGuardBegin(google::protobuf::io::Printer *printer,

                                      const std::string &guard);

    static void printHeaderGuardEnd(google::protobuf::io::Printer *printer,

                                    const std::string &guard);

    void OpenFileNamespaces(const ::google::protobuf::FileDescriptor *file,

                            google::protobuf::io::Printer *printer) const;

    void CloseFileNamespaces(const ::google::protobuf::FileDescriptor *file,

                             google::protobuf::io::Printer *printer) const;

};

} // namespace qtprotoccommon

#endif // GENERATORBASE_H