File: generate_function_reference.py

package info (click to toggle)
python-pyglm 2.8.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,008 kB
  • sloc: cpp: 53,029; python: 3,683; makefile: 7
file content (460 lines) | stat: -rw-r--r-- 18,735 bytes parent folder | download
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
import glm
import re, os, SlashBack, sys, traceback

builtin_function_or_method = type(glm.silence)

HERE = os.path.dirname(__file__)

TARGET_FOLDER = os.path.abspath(os.path.join(HERE, "../wiki/function-reference"))

functions = []

func_common = ["abs", "sign", "floor", "trunc", "round", "roundEven",
               "ceil", "fract", "mod", "min", "max", "fmin",
               "fmax", "clamp", "mix", "step", "smoothstep", "isnan",
               "isinf", "fma", "frexp", "ldexp", "floatBitsToInt",
               "floatBitsToUint", "intBitsToFloat", "uintBitsToFloat",
               "modf"]

func_exponential = ["pow", "exp", "log", "exp2", "log2", "sqrt", "inversesqrt"]

func_geometric = ["length", "distance", "dot", "cross", "normalize", "faceforward", "reflect", "refract"]

func_integer = ["uaddCarry", "usubBorrow", "umulExtended", "imulExtended",
                "bitfieldExtract", "bitfieldInsert", "bitfieldReverse",
                "bitCount", "findLSB", "findMSB"]

func_matrix = ["matrixCompMult", "outerProduct", "transpose", "determinant", "inverse"]

func_packing = ["packDouble2x32", "packUnorm2x16", "packSnorm2x16", "packSnorm4x8",
                "packUnorm4x8", "packHalf2x16", "unpackDouble2x32", "unpackUnorm2x16",
                "unpackSnorm2x16", "unpackSnorm4x8", "unpackUnorm4x8", "unpackHalf2x16"]

func_trigonometric = ["radians", "degrees", "sin", "cos", "tan", "asin", "acos", "atan",
                      "sinh", "cosh", "tanh", "asinh", "acosh", "atanh"]

func_vector_relational = ["equal", "notEqual", "lessThan", "lessThanEqual", "greaterThan",
                          "greaterThanEqual", "any", "all", "not_"]

detail = func_common + func_exponential + func_geometric + func_integer + func_matrix + \
         func_packing + func_trigonometric + func_vector_relational

color_space = ["convertLinearToSRGB", "convertSRGBToLinear"]

constants = ["epsilon", "zero", "one", "pi", "two_pi", "root_pi",
             "half_pi", "three_over_two_pi", "quarter_pi", "one_over_pi",
             "one_over_two_pi", "two_over_pi", "four_over_pi",
             "two_over_root_pi", "one_over_root_two", "root_half_pi",
             "root_two_pi", "root_ln_four", "e", "euler", "root_two",
             "root_three", "root_five", "ln_two", "ln_ln_two", "ln_ten", "third",
             "two_thirds", "golden_ratio"]

epsilon = ["epsilonEqual", "epsilonNotEqual"]

integer = ["iround", "uround"]

matrix_access = ["row", "column"]

matrix_clip_space = ["tweakedInfinitePerspective"] + \
                    [x + y for y in ["", "LH", "RH", "NO", "ZO", "LH_ZO", "LH_NO", "RH_ZO", "RH_NO"] for x in ["ortho", "frustum", "perspective", "perspectiveFov"]] +\
                    ["infinitePerspective" + y for y in ["", "LH", "RH"]]

matrix_inverse = ["affineInverse", "inverseTranspose"]

matrix_projection = ["project", "projectNO", "projectZO", "unProject", "unProjectNO", "unProjectZO", "pickMatrix"]

matrix_transform = ["identity", "translate", "rotate", "rotate_slow", "scale", "scale_slow", "lookAt",
                    "lookAtRH", "lookAtLH"]

noise = ["perlin", "simplex"]

packing_pack_methods = ["pack" + x + y for x, z in [
    ("Int", ("2x8", "4x8", "4x16", "2x16", "2x32")),
    ("Uint", ("2x8", "4x8", "4x16", "2x16", "2x32")),
    ("Unorm", ("", "1x8", "2x8", "1x16", "4x16", "3x10_1x2", "2x4", "4x4", "1x5_1x6_1x5", "3x5_1x1", "2x3_1x2")),
    ("Snorm", ("", "1x8", "2x8", "1x16", "4x16", "3x10_1x2")),
    ("Half", ("", "1x16", "4x16")),
    ("", ("I3x10_1x2", "U3x10_1x2", "F2x11_1x10", "F3x9_E1x5", "RGBM")),
    ] for y in z]

packing = [y + x for x in packing_pack_methods for y in ["", "un"]]

quaternion = ["quatLookAt", "quatLookAtLH", "quatLookAtRH", "eulerAngles", "roll", "pitch", "yaw", "mat3_cast",
              "mat4_cast", "quat_cast"]

quaternion_common = ["lerp", "slerp", "conjugate"]

quaternion_trigonometric = ["angle", "axis", "angleAxis"]

random = ["linearRand", "gaussRand", "circularRand", "sphericalRand", "diskRand", "ballRand", "setSeed"]

reciprocal = [f.format(x) for f in ("{}", "a{}", "{}h", "a{}h") for x in ("sec", "csc", "cot")]

round = ["ceilPowerOfTwo", "floorPowerOfTwo", "roundPowerOfTwo", "ceilMultiple", "floorMultiple",
         "roundMultiple"]

type_ptr = ["value_ptr", "sizeof", "make_quat"] + [f + str(x) for x in range(2, 5) for f in ("make_vec", "make_mat")] +\
           ["make_mat{}x{}".format(x, y) for x in range(2,5) for y in range(2,5)]

ulp = ["next_float", "prev_float", "float_distance"]

decompose = ["decompose"]

norm = ["distance2", "l1Norm", "l2Norm", "lMaxNorm", "length2", "lxNorm"]

polar_coordinates = ["polar", "euclidean"]

matrix_transform_2d = ["shearX", "shearY", "rotate", "translate", "scale"]

rotate_vector = ["orientation", "rotate", "rotateX", "rotateY", "rotateZ", "slerp"]

compatibility = ["lerp", "atan2", "isfinite", "saturate"]

stable_extensions = matrix_clip_space + matrix_projection + matrix_transform + quaternion_common +\
                    quaternion_trigonometric

recommended_extensions = color_space + constants + epsilon + integer + matrix_access + matrix_inverse +\
                         noise + packing + quaternion + random + reciprocal + round + type_ptr + ulp

unstable_extensions = decompose + norm + polar_coordinates + matrix_transform_2d + rotate_vector + compatibility

other_functions = ["silence", "add", "and_", "or_", "xor", "cmp", "div", "floordiv", "if_else", "inv", "lshift", "mul", "neg", "pos", "rshift", "sub", "quat_to_vec4", "vec4_to_quat"]

known_functions = detail + recommended_extensions + stable_extensions + unstable_extensions + other_functions

ignored_functions = ["test", "test_type_identification"]

multiple_expected = ["rotate", "translate", "scale", "slerp", "lerp"]

folders = {}

for raw in dir(glm):
    func = getattr(glm, raw)
    if (raw.startswith("__") and raw.endswith("__") or not isinstance(func, builtin_function_or_method)):
        continue
    functions.append(raw)

is_defined = lambda x: x in functions
is_known = lambda x: x in known_functions
is_ignored = lambda x: x in ignored_functions

for known_func in known_functions:
    if not is_defined(known_func):
        print("A 'known' function was not defined: {}".format(known_func))

    if known_func not in multiple_expected and known_functions.count(known_func) != 1:
        print("Function '{}' is known multiple times".format(known_func))


for function in functions:
    if not is_known(function) and not is_ignored(function):
        print("Function {} is not known".format(function))

FUNC_PATTERN = re.compile("(^\\w+)\\s*\\(([^)]*)\\)\\s*->\\s*(.+$)")

TEMPLATE_PATTERN = re.compile("\\\\code\\\\([A-Z]) in \\[((:?\\w+,? ?)+)\\]\\\\code\\\\")

class FunctionName:
    def __init__(self, name):
        self.name = name

    def __str__(self):
        return "glm.<code>**{}**".format(self.name)

class Parameters:
    def __init__(self, param_string):
        self.param_string = param_string

    def __str__(self):
        inner_out = []
        for param in self.param_string.split(","):
            param = param.strip()
            if not param:
                continue
            if ":" in param:
                if param.count(":") != 1:
                    print("Invalid amount of ':': {}".format(self.param_string))
                else:
                    param, type_ = param.split(":")
                    inner_out.append("**{}**: *{}*".format(param, type_.strip()))
            else:
                inner_out.append("**{}**".format(param))
                
        return "({})".format(", ".join(inner_out))

class ReturnValue:
    def __init__(self, return_value):
        self.return_value = return_value

    def __str__(self):
        return " -\\\\> *{}*".format(self.return_value)

class Description:
    def __init__(self, descr):
        self.descr = descr

    def __str__(self):
        descr = self.descr.replace("\t", "\\raw\\&emsp;&emsp;\\raw\\")
        while 1:
            match = TEMPLATE_PATTERN.search(descr)
            if match:
                descr = descr[:match.start()] + "\\raw\\<code>***{}*** in [{}]</code>\\raw\\".format(match.group(1), ", ".join(map(lambda x: "**{}**".format(x), match.group(2).split(", ")))) + descr[match.end():]
            else:
                break
        return descr


def convert_doc_entry_to_sb(subdoc):
    lines = subdoc.split("\n")
    first_line = ""
    rest_start = 0
    for line in lines:
        first_line += line
        rest_start += 1
        if "->" in line:
            break
    descr = Description("\n".join(lines[rest_start:]))
    match = FUNC_PATTERN.fullmatch(first_line)
    if match:
        func_name = FunctionName(match.group(1))
        parameters = Parameters(match.group(2))
        return_val = ReturnValue(match.group(3))
        return "\\raw\\#### <code>{}{}{}</code></code>\\raw\\\n{}\n".format(str(func_name), str(parameters), str(return_val), str(descr))
    print("{} doesn't match the FUNC_PATTERN!".format(subdoc))
    return ""

def convert_doc_to_sb(func):
    doc = func.__doc__
    name = func.__name__
    if doc.count("`") % 2 != 0:
        print ("{} doesn't have an even amount of backticks!".format(name))
    else:
        doc = doc.replace("`", "\\code\\")
    out = "\\h3\\{}() function\\h3\\\n".format(name)
    lines = doc.split("\n")
    current_subdoc = ""
    for line in lines:
        if not line.startswith("\t") and current_subdoc:
            out += convert_doc_entry_to_sb(current_subdoc)
            current_subdoc = ""
        current_subdoc += line + "\n"
    if current_subdoc.strip():
        out += convert_doc_entry_to_sb(current_subdoc)
    return out

def check_doc(func):
    name = func.__name__
    doc = func.__doc__
    for line in doc.split("\n"):
        if line.strip() and not line.startswith("\t") and not line.startswith(name) or len(line) > 100:
            print("{} has invalid doc: \n{}\n".format(name, line))
            return False
    return True

def convert_sb_file(filename):
    out_filename = os.path.splitext(filename)[0] + ".md"
    try:
        sbf = SlashBack.open(filename)
        sbf.write(out_filename)
    except SlashBack.SlashBackParserError as exception:
        print(f"\nERROR: {exception!s}", file=sys.stderr)
    except Exception as exception:
        print("\nUNHANDLED EXCEPTION OCCURED!", file=sys.stderr)
        traceback.print_exc()

def generate_reference_for(name, function_names, description):
    folder = "detail" if function_names[0] in detail else "stable_extensions" if function_names[0] in stable_extensions else \
        "recommended_extensions" if function_names[0] in recommended_extensions else "unstable_extensions" if function_names[0] in unstable_extensions else \
        "other"

    if not folder in folders:
        folders[folder] = {}

    folders[folder][name] = function_names

    if not os.path.exists(TARGET_FOLDER + "/{}/".format(folder)):
        os.mkdir(TARGET_FOLDER + "/{}/".format(folder))

    file_name = TARGET_FOLDER + "/{}/{}.sb".format(folder, name)

    file = open(file_name, "w")
    file.write("\\c\\This file was generated using a tool\\c\\\n")
    file.write("\\h1\\{} methods\\h1\\\n".format(name))
    file.write("The following methods are all part of the \\b\\{} methods\\b\\.\n".format(name))
    file.write(description)
    file.write("\n\\h2\\Table of contents\\h2\\\n")
    file.write("\\ul\\\n")

    function_names.sort()
    
    for function_name in function_names:
        file.write("\\-\\\\url #{}-function\\\\b\\{}\\b\\ function\\url\\\n".format(function_name.lower(), function_name))
    file.write("\\ul\\\n")
    
    for function_name in function_names:
        if is_defined(function_name):
            func = getattr(glm, function_name)
            if check_doc(func):
                file.write(convert_doc_to_sb(func))
    file.close()
    convert_sb_file(file_name)

        
generate_reference_for("func_common", func_common, "It contains common GLSL functions.")

generate_reference_for("func_exponential", func_exponential, "It contains exponential GLSL functions.")

generate_reference_for("func_geometric", func_geometric, "These operate on vectors as vectors, not component-wise.")

generate_reference_for("func_integer", func_integer, "It contains GLSL functions on integer types.")

generate_reference_for("func_matrix", func_matrix, "It contains GLSL matrix functions.")

generate_reference_for("func_packing", func_packing, "Provides GLSL functions to pack and unpack half, single"+\
                       " and double-precision floating point values into more compact integer types.")

generate_reference_for("func_trigonometric", func_trigonometric,
                       "Function parameters specified as angle are assumed to be in units of radians.")

generate_reference_for("func_vector_relational", func_vector_relational,
                       "Relational vector functions.")

generate_reference_for("color_space", color_space, "Allow to perform bit operations on integer values.")

generate_reference_for("constants", constants, "Provide a list of constants and precomputed useful values.")

generate_reference_for("epsilon", epsilon, "Comparison functions for a user defined epsilon values.")

generate_reference_for("integer", integer, "Contains two different rounding methods.")

generate_reference_for("matrix_access", matrix_access,
                       "Defines functions to access rows or columns of a matrix easily.")

generate_reference_for("matrix_clip_space", matrix_clip_space,
                       "Defines functions that generate clip space transformation matrices.")

generate_reference_for("matrix_inverse", matrix_inverse,
                       "Defines additional matrix inverting functions.")

generate_reference_for("matrix_projection", matrix_projection,
                       "Functions that generate common projection transformation matrices.")

generate_reference_for("matrix_transform", matrix_transform,
                       "Defines functions that generate common transformation matrices.")

generate_reference_for("noise", noise,
                       "Defines 2D, 3D and 4D procedural noise functions Based on the work of Stefan Gustavson"+\
                       " and Ashima Arts on \"webgl-noise\": \\raw\\https://github.com/ashima/webgl-noise\\raw\\ Following"+\
                       " Stefan Gustavson's paper \"Simplex noise demystified\": "+\
                       "\\raw\\http://www.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf\\raw\\")

generate_reference_for("packing", packing,
                       "This extension provides a set of function to convert vertors to packed formats.")

generate_reference_for("quaternion", quaternion,
                       "Defines a templated quaternion type and several quaternion operations.")

generate_reference_for("quaternion_common", quaternion_common,
                       "Provides common functions for quaternion types.")

generate_reference_for("quaternion_trigonometric", quaternion_trigonometric,
                       "Provides trigonometric functions for quaternion types.")

generate_reference_for("random", random,
                       "Generate random number from various distribution methods.")

generate_reference_for("reciprocal", reciprocal,
                       "Define secant, cosecant and cotangent functions.")

generate_reference_for("round", round,
                       "Rounding value to specific boundings.")

generate_reference_for("type_ptr", type_ptr,
                       "Handles the interaction between pointers and vector, matrix types. "+\
                       "This extension defines an overloaded function, glm.value_ptr. It "+\
                       "returns a pointer to the memory layout of the object. Matrix types "+\
                       "store their values in column-major order. This is useful for uploading "+\
                       "data to matrices or copying data to buffer objects.")

generate_reference_for("ulp", ulp,
                       "Allow the measurement of the accuracy of a function against a reference implementation. "+\
                       "This extension works on floating-point data and provide results in ULP.")

generate_reference_for("decompose", decompose,
                       "Decomposes a model matrix to translations, rotation and scale components.")

generate_reference_for("norm", norm,
                       "Various ways to compute vector norms.")

generate_reference_for("polar_coordinates", polar_coordinates,
                       "Conversion from Euclidean space to polar space and revert.")

generate_reference_for("matrix_transform_2d", matrix_transform_2d,
                       "Defines functions that generate common 2d transformation matrices.")

generate_reference_for("rotate_vector", rotate_vector,
                       "Function to directly rotate a vector.")

generate_reference_for("compatibility", compatibility,
                       "Provide functions to increase the compatibility with Cg and HLSL languages.")

generate_reference_for("other", other_functions,
                       "PyGLM's custom functions.")

instructions_filename = TARGET_FOLDER + "/INSTRUCTIONS.sb"

instructions_file = open(instructions_filename, "r")
instuctions = instructions_file.read()
instructions_file.close()

toc_filename = TARGET_FOLDER + "/README.sb"

toc_file = open(toc_filename, "w")
toc_file.write("{}\n".format(instuctions))
toc_file.write("\\h1\\Table of Contents\\h1\\\n")
toc_file.write("\\ul\\\n")

for folder in folders:
    sub_toc_filename = TARGET_FOLDER + "/{}/README.sb".format(folder)
    sub_toc_file = open(sub_toc_filename, "w")
    sub_toc_file.write("\\h1\\Table of Contents\\h1\\\n")
    sub_toc_file.write("\\ul\\\n")
    toc_file.write("\\-\\ \\url {0}/README.md\\{0}\\url\\\n".format(folder))
    folder_content = folders[folder]
    for functions_name in folder_content:
        sub_toc_file.write("\\-\\ \\url {0}.md \\{0} methods\\ url\\\n".format(functions_name))
        toc_file.write("\\--\\ \\url {0}/{1}.md \\{1} methods\\ url\\\n".format(folder, functions_name))
        functions = folder_content[functions_name]
        for function_name in functions:
            sub_toc_file.write("\\--\\ \\url {0}.md#{1}-function \\\\b\\{1}\\b\\ function \\ url\\\n".format(functions_name, function_name))
            toc_file.write("\\---\\ \\url {0}/{1}.md#{2}-function \\\\b\\{2}\\b\\ function \\ url\\\n".format(folder, functions_name, function_name))

    sub_toc_file.write("\\ul\\\n")
    sub_toc_file.close()
    convert_sb_file(sub_toc_filename)

toc_file.write("\\ul\\\n")

toc_file.close()

convert_sb_file(toc_filename)