docstring.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
#include <string>
#include <unordered_map>
 
#include "pybind/cloudViewer_pybind.h"
 
namespace cloudViewer {
namespace docstring {
 
class ArgumentDoc {
public:
    std::string name_ = "";
    std::string type_ = "";
    std::string default_ = "";
    // Long default values are not displayed in signature, but in docstrings
    std::string long_default_ = "";
    std::string body_ = "";
};
 
class FunctionDoc {
public:
    FunctionDoc(const std::string& pybind_doc);
 
    std::string ToGoogleDocString() const;
 
protected:
    size_t ParseFunctionName();
 
    size_t ParseSummary();
 
    void ParseArguments();
 
    void ParseReturn();
 
    static std::vector<std::string> GetArgumentTokens(
            const std::string& pybind_doc);
 
    static ArgumentDoc ParseArgumentToken(const std::string& argument_token);
 
    static std::string StringCleanAll(std::string& s,
                                      const std::string& white_space = " \t\n");
 
public:
    struct OverloadDocs {
        std::vector<ArgumentDoc> argument_docs_;
        ArgumentDoc return_doc_;
        std::string summary_ = "";
    };
    std::string name_ = "";
    std::string preamble_ = "";
    std::vector<OverloadDocs> overload_docs_;
 
protected:
    std::string pybind_doc_ = "";
    size_t doc_pos_[2] = {0, std::string::npos};
};
 
void FunctionDocInject(
        py::module& pybind_module,
        const std::string& function_name,
        const std::unordered_map<std::string, std::string>& map_parameter_docs =
                std::unordered_map<std::string, std::string>());
 
void ClassMethodDocInject(
        py::module& pybind_module,
        const std::string& class_name,
        const std::string& function_name,
        const std::unordered_map<std::string, std::string>&
                map_parameter_body_docs =
                        std::unordered_map<std::string, std::string>());
 
extern py::handle static_property;
 
}  // namespace docstring
}  // namespace cloudViewer