-
-
Notifications
You must be signed in to change notification settings - Fork 5
/
Filepath.txt
121 lines (106 loc) · 2.87 KB
/
Filepath.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
*Vital/Path/Filepath.txt* Utility module for manipulating system paths
==============================================================================
CONTENTS *Vital.Path.Filepath-contents*
INTRODUCTION |Vital.Path.Filepath-introduction|
FUNCTION |Vital.Path.Filepath-function|
==============================================================================
INTRODUCTION *Vital.Path.Filepath-introduction*
|Vital.Path.Filepath| is a utility module for manipulating file system paths.
Use this module to convert file system paths to slash-separated paths and
manipulate the paths with |Vital.Path|.
=============================================================================
FUNCTION *Vital.Path.Filepath-function*
*Vital.Path.Filepath.to_slash()*
to_slash({path})
Return simplified slash (/) path (|String|) from the file system {path}.
>
" On Unix
Filepath.to_slash('/usr/local')
" -> '/usr/local'
" On Windows
Filepath.to_slash('C:\Windows\System32')
" -> '/C:/Windows/System32'
<
*Vital.Path.Filepath.from_slash()*
from_slash({path})
Return simplified file system path (|String|) of the slash (/) {path}.
>
" On Unix
Filepath.from_slash('/usr/local')
" -> '/usr/local'
" On Windows
Filepath.from_slash('/C:/Windows/System32')
" -> 'C:\Windows\System32'
<
*Vital.Path.Filepath.is_root()*
is_root({path})
Return 1 when the {path} is the file system root path.
>
" On Unix
Filepath.is_root('/')
" -> 1
Filepath.is_root('')
" -> 0
Filepath.is_root('/usr/local')
" -> 0
" On Windows
Filepath.is_root('')
" -> 1
Filepath.is_root('C:\Windows\System32')
" -> 0
<
*Vital.Path.Filepath.is_drive_root()*
is_drive_root({path})
Return 1 when the {path} is the file system drive root path.
>
" On Unix
Filepath.is_drive_root('/')
" -> 1
Filepath.is_drive_root('')
" -> 0
Filepath.is_drive_root('/usr/local')
" -> 0
" On Windows
Filepath.is_drive_root('C:\')
" -> 1
Filepath.is_drive_root('')
" -> 0
Filepath.is_drive_root('C:\Windows\System32')
" -> 0
<
*Vital.Path.Filepath.is_absolute()*
is_absolute({path})
Return 1 when the {path} is the file system absolute path.
>
" On Unix
Filepath.is_absolute('/usr/local')
" -> 1
Filepath.is_absolute('/')
" -> 1
Filepath.is_absolute('') " To keep behavior consistency to Win
" -> 1
Filepath.is_absolute('usr/local')
" -> 0
" On Windows
Filepath.is_absolute('C:\Windows\System32')
" -> 1
Filepath.is_absolute('C:\')
" -> 1
Filepath.is_absolute('')
" -> 1
Filepath.is_absolute('Windows\System32')
" -> 0
<
*Vital.Path.Filepath.join()*
join({paths})
Return file system joined path (|String|) of {paths}.
>
" On Unix
Filepath.join(['/usr/local', 'bin'])
" -> '/usr/local/bin'
" On Windows
Filepath.join(['C:\Windows\System32', 'Foo'])
" -> 'C:\Windows\System32\Foo'
<
==============================================================================
vim:tw=78:fo=tcq2mM:ts=8:ft=help:norl