Skip to main content

CompileCommand

Struct CompileCommand 

Source
pub struct CompileCommand {
    pub file: PathBuf,
    pub directory: Option<PathBuf>,
    pub arguments: Vec<String>,
}
Expand description

One entry of a compile_commands.json.

The format every C++ build system can emit, and the only reliable way to learn how a project is meant to be compiled. Guessing include paths from a directory listing is what produces an analysis that works on the author’s machine and fails everywhere else.

Fields§

§file: PathBuf

The file this command compiles.

§directory: Option<PathBuf>

The directory the command runs in.

§arguments: Vec<String>

The command, split into arguments.

Implementations§

Source§

impl CompileCommand

Source

pub fn to_config(&self) -> CompilerConfig

Read the compiler configuration out of this command’s arguments.

Only the flags that change what the code means are read: include paths, defines, the standard, the target, and the -o/-c/input/output plumbing that is skipped. A flag this does not know is ignored rather than guessed at, because a wrong -D is worse than a missing one.

Source

pub fn to_config_with( &self, read: &mut dyn FnMut(&Path) -> Option<String>, ) -> CompilerConfig

The same, with the command’s response files read — which is what a build system’s own command line means, and what CMake’s database needs.

CMake does not write its include paths into the arguments: it writes @CMakeFiles/<target>.dir/includes_CXX.rsp and puts the -I flags in that file, for the Makefile and Ninja generators alike. Measured on a real CMake project: every entry of its compile_commands.json was of that shape, so a reader that does not follow the indirection sees a project with no include paths at all — its own headers stop resolving, and the file list stops being the build’s.

read is the caller’s, because this crate reads through a provider rather than the filesystem: the server has to answer for a buffer nobody has saved, and a test has to be able to say what a file holds.

Trait Implementations§

Source§

impl Clone for CompileCommand

Source§

fn clone(&self) -> CompileCommand

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CompileCommand

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl Eq for CompileCommand

Source§

impl PartialEq for CompileCommand

Source§

fn eq(&self, other: &CompileCommand) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CompileCommand

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.