blob: 07d97babbeea0bcde1e70eb22b80401de1e404d0 [file] [log] [blame]
Johnny Chen5cb6cab2011-07-19 22:41:47 +00001//===-- SWIG Interface for SBFileSpec ---------------------------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10namespace lldb {
11
Johnny Chenfd33bac2011-07-20 01:06:37 +000012%feature("docstring",
13"Represents a file specfication that divides the path into a directory and
14basename. The string values of the paths are put into uniqued string pools
15for fast comparisons and efficient memory usage.
16
17For example, the following code
18
19 lineEntry = context.GetLineEntry()
20 self.expect(lineEntry.GetFileSpec().GetDirectory(), 'The line entry should have the correct directory',
21 exe=False,
22 substrs = [self.mydir])
23 self.expect(lineEntry.GetFileSpec().GetFilename(), 'The line entry should have the correct filename',
24 exe=False,
25 substrs = ['main.c'])
26 self.assertTrue(lineEntry.GetLine() == self.line,
27 'The line entry's line number should match ')
28
29gets the line entry from the symbol context when a thread is stopped.
30It gets the file spec corresponding to the line entry and checks that
31the filename and the directory matches wat we expect.
32") SBFileSpec;
Johnny Chen5cb6cab2011-07-19 22:41:47 +000033class SBFileSpec
34{
35public:
36 SBFileSpec ();
37
38 SBFileSpec (const lldb::SBFileSpec &rhs);
39
40 SBFileSpec (const char *path);// Deprected, use SBFileSpec (const char *path, bool resolve)
41
42 SBFileSpec (const char *path, bool resolve);
43
44 ~SBFileSpec ();
45
46 bool
47 IsValid() const;
48
49 bool
50 Exists () const;
51
52 bool
53 ResolveExecutableLocation ();
54
55 const char *
56 GetFilename() const;
57
58 const char *
59 GetDirectory() const;
60
61 uint32_t
62 GetPath (char *dst_path, size_t dst_len) const;
63
64 static int
65 ResolvePath (const char *src_path, char *dst_path, size_t dst_len);
66
67 bool
68 GetDescription (lldb::SBStream &description) const;
Greg Clayton1b925202012-01-29 06:07:39 +000069
70 %pythoncode %{
Greg Claytonb302dff2012-02-01 08:09:32 +000071 def __get_fullpath__(self):
72 spec_dir = self.GetDirectory()
73 spec_file = self.GetFilename()
74 if spec_dir and spec_file:
75 return '%s/%s' % (spec_dir, spec_file)
76 elif spec_dir:
77 return spec_dir
78 elif spec_file:
79 return spec_file
80 return None
81
82 __swig_getmethods__["fullpath"] = __get_fullpath__
Greg Clayton2a94be12012-06-29 22:00:42 +000083 if _newclass: fullpath = property(__get_fullpath__, None, doc='''A read only property that returns the fullpath as a python string.''')
Greg Claytonb302dff2012-02-01 08:09:32 +000084
Greg Clayton1b925202012-01-29 06:07:39 +000085 __swig_getmethods__["basename"] = GetFilename
Greg Clayton2a94be12012-06-29 22:00:42 +000086 if _newclass: basename = property(GetFilename, None, doc='''A read only property that returns the path basename as a python string.''')
Greg Clayton1b925202012-01-29 06:07:39 +000087
88 __swig_getmethods__["dirname"] = GetDirectory
Greg Clayton2a94be12012-06-29 22:00:42 +000089 if _newclass: dirname = property(GetDirectory, None, doc='''A read only property that returns the path directory name as a python string.''')
Greg Clayton1b925202012-01-29 06:07:39 +000090
91 __swig_getmethods__["exists"] = Exists
Greg Clayton2a94be12012-06-29 22:00:42 +000092 if _newclass: exists = property(Exists, None, doc='''A read only property that returns a boolean value that indicates if the file exists.''')
Greg Clayton1b925202012-01-29 06:07:39 +000093 %}
94
Johnny Chen5cb6cab2011-07-19 22:41:47 +000095};
96
97} // namespace lldb