source_jump.hpp

Go to the documentation of this file.

// source_jump.hpp — Inspector source-jump: resolve a view's authored
// source location and open it in the user's editor.
//
// This is the concrete "jump to source" action. The editor-URI
// configuration lives in pulp/inspect/editor_url.hpp; source locations
// are recorded on `pulp::view::View` from React's `__source` prop. This
// file ties them together:
//
//   1. resolve_source_jump() — given a config + a View's recorded
//      source location, format the editor URL via format_editor_url().
//   2. launch_editor_url() — hand the URL to the OS so the editor
//      actually opens. Kept behind a small seam so headless tests can
//      run the resolve path with `dryRun` and never spawn a process.
//
// The launch shim deliberately lives in inspect/ (dev-tooling), not in
// core/runtime — it is only ever used by the inspector overlay and the
// inspector protocol handler, and is not part of the SDK public API.
#pragma once
 
#include <pulp/inspect/editor_url.hpp>
 
#include <optional>
#include <string>
#include <string_view>
 
namespace pulp::view { class View; }
 
namespace pulp::inspect {

struct SourceJumpResult {
    bool ok = false;
    std::string url;     
    std::string path;    
    int line = 0;        
    int col = 0;         
    bool launched = false;   
    std::string error;  
};

SourceJumpResult resolve_source_jump(const InspectorConfig& config,
                                     const pulp::view::View* view);

bool launch_editor_url(std::string_view url, std::string* error = nullptr);

SourceJumpResult jump_to_source(const InspectorConfig& config,
                                const pulp::view::View* view,
                                bool dry_run);
 
} // namespace pulp::inspect