* added an armature submenu where python defined armatures can go.
[blender.git] / release / scripts / modules / bpy / utils.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20
21 import bpy
22 import os
23
24 def expandpath(path):
25     if path.startswith("//"):
26         return os.path.join(os.path.dirname(bpy.data.filename), path[2:])
27
28     return path
29
30
31 _unclean_chars = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, \
32     17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, \
33     35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 46, 47, 58, 59, 60, 61, 62, 63, \
34     64, 91, 92, 93, 94, 96, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, \
35     133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, \
36     147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, \
37     161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, \
38     175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, \
39     189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, \
40     203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, \
41     217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, \
42     231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241, 242, 243, 244, \
43     245, 246, 247, 248, 249, 250, 251, 252, 253, 254]
44
45 _unclean_chars = ''.join([chr(i) for i in _unclean_chars])
46
47 def clean_name(name, replace="_"):
48     '''
49     All characters besides A-Z/a-z, 0-9 are replaced with "_"
50     or the replace argumet if defined.
51     '''
52     for ch in _unclean_chars:
53         name = name.replace(ch,  replace)
54     return name
55
56 def display_name(name):
57     '''
58     Only capitalize all lowercase names, mixed case use them as is.
59     should work with filenames and module names.
60     '''
61     name_base = os.path.splitext(name)[0]
62
63     # string replacements
64     name_base = name_base.replace("_colon_", ":")
65
66     name_base = name_base.replace("_", " ")
67
68     if name_base.lower() == name_base:
69         return ' '.join([w[0].upper() + w[1:] for w in name_base.split()])
70     else:
71         return name_base
72
73
74 # base scripts
75 _scripts = os.path.join(os.path.dirname(__file__), os.path.pardir, os.path.pardir)
76 _scripts = (os.path.normpath(_scripts), )
77
78 def script_paths(*args):
79     scripts = list(_scripts)
80
81     # add user scripts dir
82     user_script_path = bpy.context.user_preferences.filepaths.python_scripts_directory
83
84     if not user_script_path:
85         # XXX - WIN32 needs checking, perhaps better call a blender internal function.
86         user_script_path = os.path.join(os.path.expanduser("~"), ".blender", "scripts")
87
88     user_script_path = os.path.normpath(user_script_path)
89
90     if user_script_path not in scripts and os.path.isdir(user_script_path):
91         scripts.append(user_script_path)
92
93     if not args:
94         return scripts
95
96     subdir = os.path.join(*args)
97     script_paths = []
98     for path in scripts:
99         path_subdir = os.path.join(path, subdir)
100         if os.path.isdir(path_subdir):
101             script_paths.append(path_subdir)
102
103     return script_paths
104
105
106 _presets = os.path.join(_scripts[0], "presets") # FIXME - multiple paths
107
108 def preset_paths(subdir):
109     '''
110     Returns a list of paths for a spesific preset.
111     '''
112
113     return (os.path.join(_presets, subdir), )