xref: /freebsd/contrib/llvm-project/lldb/bindings/interface/SBModuleSpecDocstrings.i (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1*06c3fb27SDimitry Andric %feature("docstring", "
2*06c3fb27SDimitry Andric     Get const accessor for the module file.
3*06c3fb27SDimitry Andric 
4*06c3fb27SDimitry Andric     This function returns the file for the module on the host system
5*06c3fb27SDimitry Andric     that is running LLDB. This can differ from the path on the
6*06c3fb27SDimitry Andric     platform since we might be doing remote debugging.
7*06c3fb27SDimitry Andric 
8*06c3fb27SDimitry Andric     @return
9*06c3fb27SDimitry Andric         A const reference to the file specification object."
10*06c3fb27SDimitry Andric ) lldb::SBModuleSpec::GetFileSpec;
11*06c3fb27SDimitry Andric 
12*06c3fb27SDimitry Andric %feature("docstring", "
13*06c3fb27SDimitry Andric     Get accessor for the module platform file.
14*06c3fb27SDimitry Andric 
15*06c3fb27SDimitry Andric     Platform file refers to the path of the module as it is known on
16*06c3fb27SDimitry Andric     the remote system on which it is being debugged. For local
17*06c3fb27SDimitry Andric     debugging this is always the same as Module::GetFileSpec(). But
18*06c3fb27SDimitry Andric     remote debugging might mention a file '/usr/lib/liba.dylib'
19*06c3fb27SDimitry Andric     which might be locally downloaded and cached. In this case the
20*06c3fb27SDimitry Andric     platform file could be something like:
21*06c3fb27SDimitry Andric     '/tmp/lldb/platform-cache/remote.host.computer/usr/lib/liba.dylib'
22*06c3fb27SDimitry Andric     The file could also be cached in a local developer kit directory.
23*06c3fb27SDimitry Andric 
24*06c3fb27SDimitry Andric     @return
25*06c3fb27SDimitry Andric         A const reference to the file specification object."
26*06c3fb27SDimitry Andric ) lldb::SBModuleSpec::GetPlatformFileSpec;
27*06c3fb27SDimitry Andric 
28*06c3fb27SDimitry Andric %feature("docstring",
29*06c3fb27SDimitry Andric "Represents a list of :py:class:`SBModuleSpec`."
30*06c3fb27SDimitry Andric ) lldb::SBModuleSpecList;
31