class Analyzer::Cpp::Crow

Defined in:

analyzer/analyzers/cpp/crow.cr

Constant Summary

BLUEPRINT_DECL_REGEX = /(?:crow::)?Blueprint\s+([A-Za-z_][A-Za-z0-9_]*)\s*\(\s*"([^"]*)"/

crow::Blueprint name("prefix", ...) — first string arg is the URL prefix.

BODY_ACCESS = /\b(req|request)\s*\.\s*body\b/
BP_NEST_REGEX = /([A-Za-z_][A-Za-z0-9_]*)\s*\.\s*register_blueprint\s*\(\s*([A-Za-z_][A-Za-z0-9_]*)\s*\)/

parent.register_blueprint(child) — nests child under parent's prefix.

BP_ROUTE_REGEX = /CROW_BP_ROUTE\s*\(\s*([A-Za-z_][A-Za-z0-9_]*)\s*,\s*"([^"]*)"\s*\)/

CROW_BP_ROUTE(bp, "/path") — blueprint-scoped route registration. Group 1 = blueprint identifier, group 2 = route literal.

COOKIE_GET = /\bget_cookie\s*\(\s*"([^"]+)"/

ctx.get_cookie("name") via the CookieParser middleware.

CPP_EXTENSIONS = [".cpp", ".cc", ".cxx", ".h", ".hpp", ".hxx"]
CROW_METHOD_TOKEN = /CROW_HTTP_METHOD_([A-Za-z]+)/
EVIDENCE_RE = Regex.union("CROW_ROUTE", "CROW_BP_ROUTE", "CROW_WEBSOCKET_ROUTE", "route_dynamic")

Precompiled union for the per-file evidence gate in analyze_file, so it costs a single PCRE2 match instead of up to four naive substring scans.

HEADER_VALUE = /get_header_value\s*\(\s*"([^"]+)"/
HTTP_METHOD_TOKEN = /(?:crow::)?HTTPMethod::([A-Za-z]+)/
METHOD_TOKEN = /"([A-Za-z]+)"_method/
METHODS_REGEX = /\.methods\s*\(([^)]*)\)/

.methods("POST"_method, "GET"_method) clause.

PATH_PARAM_REGEX = /<([^<>:]+)(?::([^<>]+))?>/

Path placeholder: , , , , — and the non-standard but occasionally seen type:name form.

ROUTE_DYNAMIC_REGEX = /\.\s*route_dynamic\s*\(\s*"([^"]*)"\s*\)/

app.route_dynamic("/path") — runtime string route (no compile-time macro).

ROUTE_REGEX = /CROW_ROUTE\s*\(\s*[A-Za-z_][A-Za-z0-9_]*\s*,\s*"([^"]*)"\s*\)/

CROW_ROUTE(app, "/path") — the app identifier and route literal.

URL_PARAM_GET = /url_params\s*\.\s*get(?:_list|_dict)?(?:\s*<[^>]+>)?\s*\(\s*"([^"]+)"/

url_params.get("x") plus the list/dict variants get_list / get_dict.

WEBSOCKET_REGEX = /CROW_WEBSOCKET_ROUTE\s*\(\s*[A-Za-z_][A-Za-z0-9_]*\s*,\s*"([^"]*)"\s*\)/

CROW_WEBSOCKET_ROUTE(app, "/path") — websocket upgrade endpoint.

Class Method Summary

Instance Method Summary

Instance methods inherited from class Analyzer

analyze analyze, base_path : String base_path, base_paths : Array(String) base_paths, base_relative_path(path : String) : String base_relative_path, callees_needed? : Bool callees_needed?, content_matches?(content : String, markers : Regex) : Bool content_matches?, 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, tech : String tech, 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

Macros inherited from class Analyzer

analyzer_for(tech) analyzer_for

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, get_files_by_basename(basename : String) : Array(String) get_files_by_basename, 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_files_by_relative_path(relative_path : String, root : String = "") : Array(String) get_files_by_relative_path, 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, walked_path(expanded : String) : String walked_path

Class Method Detail

def self.tech_name : String #

[View source]

Instance Method Detail

def analyze #

[View source]
def tech : String #

Instance-side view of the same declaration. The per-file rescues live on this base class, which has no way to name the analyzer that is running inside them, so a skipped file could not be attributed to a tech. Deriving it from analyzer_for keeps the name written exactly once.


[View source]