clang-tools  7.0.0
Public Member Functions | Static Public Member Functions | Friends | List of all members
clang::clangd::URI Class Reference

A URI describes the location of a source file. More...

#include <URI.h>

Public Member Functions

 URI (llvm::StringRef Scheme, llvm::StringRef Authority, llvm::StringRef Body)
 
llvm::StringRef scheme () const
 Returns decoded scheme e.g. "https". More...
 
llvm::StringRef authority () const
 Returns decoded authority e.g. "reviews.lvm.org". More...
 
llvm::StringRef body () const
 Returns decoded body e.g. "/D41946". More...
 
std::string toString () const
 Returns a string URI with all components percent-encoded. More...
 

Static Public Member Functions

static llvm::Expected< URIcreate (llvm::StringRef AbsolutePath, llvm::StringRef Scheme)
 Creates a URI for a file in the given scheme. More...
 
static URI createFile (llvm::StringRef AbsolutePath)
 This creates a file:// URI for AbsolutePath. The path must be absolute. More...
 
static llvm::Expected< URIparse (llvm::StringRef Uri)
 Parse a URI string "<scheme>:[//<authority>/]<path>". More...
 
static llvm::Expected< std::string > resolve (const URI &U, llvm::StringRef HintPath="")
 Resolves the absolute path of U. More...
 
static llvm::Expected< std::string > includeSpelling (const URI &U)
 Gets the preferred spelling of this file for #include, if there is one, e.g. More...
 

Friends

bool operator== (const URI &LHS, const URI &RHS)
 
bool operator< (const URI &LHS, const URI &RHS)
 

Detailed Description

A URI describes the location of a source file.

In the simplest case, this is a "file" URI that directly encodes the absolute path to a file. More abstract cases are possible: a shared index service might expose repo:// URIs that are relative to the source control root.

Clangd handles URIs of the form <scheme>:[//<authority>]<body>. It doesn't further split the authority or body into constituent parts (e.g. query strings is included in the body).

Definition at line 29 of file URI.h.

Constructor & Destructor Documentation

◆ URI()

clang::clangd::URI::URI ( llvm::StringRef  Scheme,
llvm::StringRef  Authority,
llvm::StringRef  Body 
)

Definition at line 133 of file URI.cpp.

Member Function Documentation

◆ authority()

llvm::StringRef clang::clangd::URI::authority ( ) const
inline

Returns decoded authority e.g. "reviews.lvm.org".

Definition at line 36 of file URI.h.

◆ body()

llvm::StringRef clang::clangd::URI::body ( ) const
inline

Returns decoded body e.g. "/D41946".

Definition at line 38 of file URI.h.

References create(), createFile(), includeSpelling(), parse(), resolve(), and toString().

◆ create()

llvm::Expected< URI > clang::clangd::URI::create ( llvm::StringRef  AbsolutePath,
llvm::StringRef  Scheme 
)
static

Creates a URI for a file in the given scheme.

Scheme must be registered. The URI is percent-encoded.

Definition at line 174 of file URI.cpp.

Referenced by body(), createFile(), and clang::clangd::URIDistance::distance().

◆ createFile()

URI clang::clangd::URI::createFile ( llvm::StringRef  AbsolutePath)
static

This creates a file:// URI for AbsolutePath. The path must be absolute.

Definition at line 184 of file URI.cpp.

References create(), and clang::tidy::cppcoreguidelines::toString().

Referenced by body(), and clang::clangd::URIForFile::uri().

◆ includeSpelling()

llvm::Expected< std::string > clang::clangd::URI::includeSpelling ( const URI U)
static

Gets the preferred spelling of this file for #include, if there is one, e.g.

<system_header.h>, "path/to/x.h".

This allows URI schemas to provide their customized include paths.

Returns an empty string if normal include-shortening based on the absolute path should be used. Fails if the URI is not valid in the schema.

Definition at line 199 of file URI.cpp.

Referenced by body().

◆ parse()

llvm::Expected< URI > clang::clangd::URI::parse ( llvm::StringRef  Uri)
static

Parse a URI string "<scheme>:[//<authority>/]<path>".

Percent-encoded characters in the URI will be decoded.

Definition at line 156 of file URI.cpp.

References Pos.

Referenced by body(), clang::clangd::URIDistance::distance(), and clang::clangd::fromJSON().

◆ resolve()

llvm::Expected< std::string > clang::clangd::URI::resolve ( const URI U,
llvm::StringRef  HintPath = "" 
)
static

Resolves the absolute path of U.

If there is no matching scheme, or the URI is invalid in the scheme, this returns an error.

HintPath A related path, such as the current file or working directory, which can help disambiguate when the same file exists in many workspaces.

Definition at line 191 of file URI.cpp.

Referenced by body(), and clang::clangd::fromJSON().

◆ scheme()

llvm::StringRef clang::clangd::URI::scheme ( ) const
inline

Returns decoded scheme e.g. "https".

Definition at line 34 of file URI.h.

◆ toString()

std::string clang::clangd::URI::toString ( ) const

Returns a string URI with all components percent-encoded.

Definition at line 141 of file URI.cpp.

Referenced by body(), and clang::clangd::URIForFile::uri().

Friends And Related Function Documentation

◆ operator<

bool operator< ( const URI LHS,
const URI RHS 
)
friend

Definition at line 78 of file URI.h.

◆ operator==

bool operator== ( const URI LHS,
const URI RHS 
)
friend

Definition at line 73 of file URI.h.


The documentation for this class was generated from the following files: