class
Analyzer::Zig::Zap
- Analyzer::Zig::Zap
- Analyzer
- Reference
- Object
Overview
zap exposes routes two ways:
- Endpoint structs — a struct (often the whole file via
pub const X = @This();) carrying apathslug and one verb method per supported HTTP method (pub fn get/post/put/delete/patch/options/ head). The slug is usually bound where the endpoint is instantiated (X.init("/users", …),.{ .path = "/stop" }), not inside the struct, so paths are resolved project-wide and keyed by struct type. zap.Router—router.handle_func("/p", &inst, &T.method)androuter.handle_func_unbound("/p", handler)map a path to a handler for any method.
Defined in:
analyzer/analyzers/zig/zap.crConstant Summary
-
ENDPOINT_INIT_RE =
/(?:zap\s*\.\s*)?Endpoint\s*\.\s*init\s*\(\s*\.\s*\{/ -
Modern
zap.Endpoint.init(.{ .path = …, .get = handler, … })API: the supported HTTP methods are declared as option fields bound to handler functions, instead of aspub fn get/… verb methods on the struct. The path field is usually a parameter resolved at theT.init("/p", …)call site, so it is reused through the samebindingsmachinery. -
FIELD_PATH_RE =
/\bpath\s*:\s*\[\]const u8\s*=\s*"([^"]*)"/ -
HANDLE_FUNC_RE =
/\.\s*handle_func(_unbound)?\s*\(/ -
IMPORT_RE =
/(?:pub\s+)?(?:const|var)\s+([A-Za-z_]\w*)\s*=\s*@import\(\s*"([^"]+\.zig)"\s*\)/ -
INIT_RE =
/(?<![A-Za-z0-9_])([A-Za-z_]\w*)\.init\s*\(([^()]*)\)/ -
.is intentionally NOT in the lookbehind: endpoint types are commonly reached through a namespace re-export (Endpoints.UserWeb.init("/u")), and the meaningful key is the final segment (UserWeb), which is itself preceded by a.. -
INIT_VERB_RE =
/\.\s*(get|post|put|delete|patch|options|head)\s*=\s*&?\s*([A-Za-z_][\w.]*)/ -
LITERAL_PATH_RE =
/\.path\s*=\s*"([^"]*)"/ -
PATH_OR_INIT_RE =
Regex.union(".path", ".init(") -
Cheap path-binding gate: one precompiled
Regex.unionscan (PCRE2 JIT) in place of two naiveString#includes?char scans. Equivalent toincludes?(".path") || includes?(".init("). -
STRUCT_DECL_RE =
/(?:^|[^A-Za-z0-9_.])(?:pub\s+)?const\s+([A-Za-z_]\w*)\s*=\s*struct\s*\{/ -
THIS_DECL_RE =
/(?:^|[^A-Za-z0-9_.])(?:pub\s+)?const\s+([A-Za-z_]\w*)\s*=\s*@This\(\)/ -
VERB_METHOD =
{"get" => "GET", "post" => "POST", "put" => "PUT", "delete" => "DELETE", "patch" => "PATCH", "options" => "OPTIONS", "head" => "HEAD"} -
VERBS =
["get", "post", "put", "delete", "patch", "options", "head"] of ::String
Class Method Summary
Instance Method Summary
- #analyze
-
#tech : String
Instance-side view of the same declaration.
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
Instance Method Detail
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.