editor_url.hpp

Go to the documentation of this file.

// editor_url.hpp — Inspector source-jump editor URI configuration.
//
// This is the configuration plumbing for which editor URI scheme to use
// when source-jump opens a file:line in the user's editor. The actual
// jump action lives in source_jump.hpp; this file deals with the
// template and its substitution.
//
// Common editor URL templates (any of these are valid `editor_url_template`
// values for `InspectorConfig`):
//
//   VS Code   : "vscode://file/{path}:{line}"
//   Cursor    : "cursor://file/{path}:{line}"
//   Zed       : "zed://file/{path}:{line}:{col}"
//   Sublime   : "sublime://open?url=file://{path}&line={line}"
//   JetBrains : "idea://open?file={path}&line={line}"
//
// The substitution helper `format_editor_url` replaces `{path}`, `{line}`,
// and `{col}` tokens with the supplied values. Tokens not present in the
// template are silently ignored (so a Cursor template without `{col}` will
// still render correctly when a column is supplied).
//
// The runtime config (`InspectorConfig::editor_url_template`) is overridden
// by the `PULP_INSPECTOR_EDITOR_URL` environment variable when present, so
// developers can switch editors per-shell without rebuilding.
#pragma once
 
#include <cstdint>
#include <optional>
#include <string>
#include <string_view>
 
namespace pulp::inspect {

struct InspectorConfig {
    std::string editor_url_template = "vscode://file/{path}:{line}";
};

enum class EditorUrlSource {
    Default,      
    Config,       
    Environment,  
};

std::string format_editor_url(std::string_view tmpl,
                              std::string_view path,
                              int line,
                              std::optional<int> col = std::nullopt);

bool validate_editor_url_template(std::string_view tmpl,
                                  std::string* error_out = nullptr);

std::optional<std::string> editor_url_env_override();

struct EffectiveEditorUrl {
    std::string template_str;
    EditorUrlSource source = EditorUrlSource::Default;
};
 
EffectiveEditorUrl effective_editor_url(const InspectorConfig& config);

std::string_view editor_url_source_name(EditorUrlSource source);
 
} // namespace pulp::inspect