class Analyzer::Cpp::Oatpp

Overview

oat++ (oatpp) — routes are declared inside an ApiController subclass with code-gen macros:

ENDPOINT("GET", "users/{userId}", getUserById, PATH(Int32, userId)) { ... } ENDPOINT_ASYNC("GET", "room/{roomId}", ChatHTML) { ...Action class... }

The verb and path are the first two macro arguments; the remaining arguments of a sync ENDPOINT are typed parameter declarations (PATH/QUERY/HEADER/BODY_DTO/…). Async endpoints declare their parameters inside the generated coroutine class, so only the path placeholders are mined from those.

Defined in:

analyzer/analyzers/cpp/oatpp.cr

Constant Summary

CPP_EXTENSIONS = [".cpp", ".cc", ".cxx", ".h", ".hpp", ".hxx"]
ENDPOINT_ASYNC_REGEX = /\bENDPOINT_ASYNC\s*\(/
ENDPOINT_REGEX = /\bENDPOINT\s*\(/
HTTP_VERBS = Set {"GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"}
LIBRARY_EVIDENCE_RE = Regex.union("oatpp", "ApiController")

Precompiled unions for analyze_file's two per-file evidence gates, so each costs a single PCRE2 match instead of up to two naive substring scans.

MACRO_EVIDENCE_RE = Regex.union("ENDPOINT(", "ENDPOINT_ASYNC(")
PATH_PARAM_REGEX = /\{([^{}\/]+)\}/

Instance Method Summary

Instance methods inherited from class Analyzer

analyze analyze, base_path : String base_path, base_paths : Array(String) base_paths, callees_needed? : Bool callees_needed?, http_header_name(name : String) : String | Nil http_header_name, line_number_for_index(content : String, char_index : Int32) : Int32 line_number_for_index, logger : NoirLogger logger, parallel_analyze(files : Array(String), &block : String -> Nil) parallel_analyze, read_file_content(path : String) : String read_file_content, result : Array(Endpoint) result, unique_params(params : Array(Param)) : Array(Param) unique_params, url : String url, web_root_path(path : String, markers : Array(String)) : String web_root_path

Constructor methods inherited from class Analyzer

new(options : Hash(String, YAML::Any)) new

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, get_files_by_extension(extension : String) : Array(String) get_files_by_extension, get_files_by_extensions(extensions : Array(String)) : Array(String) get_files_by_extensions, get_files_by_prefix(prefix : String) : Array(String) get_files_by_prefix, get_files_by_prefix_and_extension(prefix : String, extension : String) : Array(String) get_files_by_prefix_and_extension, get_public_dir_files(base_path : String, folder : String) : Array(String) get_public_dir_files, get_public_files(base_path : String, anchors : Array(String) = ["shard.yml", "Gemfile"]) : Array(String) get_public_files

Instance Method Detail

def analyze #

[View source]