xref: /freebsd/contrib/llvm-project/lldb/bindings/interface/SBFileSpecDocstrings.i (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1 %feature("docstring",
2 "Represents a file specification that divides the path into a directory and
3 basename.  The string values of the paths are put into uniqued string pools
4 for fast comparisons and efficient memory usage.
5 
6 For example, the following code ::
7 
8         lineEntry = context.GetLineEntry()
9         self.expect(lineEntry.GetFileSpec().GetDirectory(), 'The line entry should have the correct directory',
10                     exe=False,
11             substrs = [self.mydir])
12         self.expect(lineEntry.GetFileSpec().GetFilename(), 'The line entry should have the correct filename',
13                     exe=False,
14             substrs = ['main.c'])
15         self.assertTrue(lineEntry.GetLine() == self.line,
16                         'The line entry's line number should match ')
17 
18 gets the line entry from the symbol context when a thread is stopped.
19 It gets the file spec corresponding to the line entry and checks that
20 the filename and the directory matches what we expect.") lldb::SBFileSpec;
21