mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-31 00:06:02 -04:00
136 lines
4.6 KiB
Python
136 lines
4.6 KiB
Python
import sys
|
|
import os
|
|
import json
|
|
import glob
|
|
from copy import deepcopy
|
|
|
|
sys.path.append(
|
|
os.path.join(
|
|
os.path.dirname(os.path.realpath(__file__)),
|
|
'../python/ext-libs'))
|
|
|
|
cpp = open(sys.argv[1], "w", encoding="utf-8")
|
|
cpp.write(
|
|
"#include \"qgsexpression.h\"\n"
|
|
"#include \"qgsexpression_p.h\"\n"
|
|
"#include <mutex>\n"
|
|
"\n"
|
|
"void QgsExpression::initFunctionHelp()\n"
|
|
"{\n"
|
|
" static std::once_flag initialized;\n"
|
|
" std::call_once( initialized, []\n"
|
|
" {"
|
|
)
|
|
|
|
|
|
def quote(v):
|
|
if isinstance(v, dict):
|
|
for k in v:
|
|
v[k] = quote(v[k])
|
|
return v
|
|
elif isinstance(v, list):
|
|
return map(quote, v)
|
|
|
|
elif isinstance(v, str):
|
|
return v.replace('"', '\\"').replace('\n', '\\n')
|
|
|
|
elif isinstance(v, bool):
|
|
return v
|
|
|
|
else:
|
|
raise BaseException("unexpected type " + repr(v))
|
|
|
|
|
|
for f in sorted(glob.glob('resources/function_help/json/*')):
|
|
with open(f, encoding="utf-8") as function_file:
|
|
try:
|
|
json_params = json.load(function_file)
|
|
except:
|
|
print(f)
|
|
raise
|
|
|
|
json_params = quote(json_params)
|
|
|
|
for field in ['name', 'type']:
|
|
if field not in json_params:
|
|
raise BaseException(f"{f}: {field} missing")
|
|
|
|
if not json_params['type'] in ['function', 'operator', 'value', 'expression', 'group']:
|
|
raise BaseException("{}: invalid type {} ".format(f, json_params['type']))
|
|
|
|
if 'variants' not in json_params:
|
|
# convert single variant shortcut to a expanded variant
|
|
v = {}
|
|
for i in json_params:
|
|
v[i] = json_params[i]
|
|
|
|
v['variant'] = json_params['name']
|
|
v['variant_description'] = json_params['description']
|
|
json_params['variants'] = [v]
|
|
|
|
name = "\"{}\"".format(json_params['name'])
|
|
|
|
if json_params['type'] == 'operator':
|
|
for v in json_params['variants']:
|
|
if 'arguments' not in v:
|
|
raise BaseException("%s: arguments expected for operator" % f)
|
|
a_list = list(deepcopy(v['arguments']))
|
|
if not 1 <= len(a_list) <= 2:
|
|
raise BaseException("%s: 1 or 2 arguments expected for operator found %i" % (f, len(a_list)))
|
|
|
|
cpp.write("\n\n QgsExpression::functionHelpTexts().insert( QStringLiteral( {0} ),\n Help( QStringLiteral( {0} ), tr( \"{1}\" ), tr( \"{2}\" ),\n QList<HelpVariant>()".format(
|
|
name, json_params['type'], json_params['description'])
|
|
)
|
|
|
|
for v in json_params['variants']:
|
|
cpp.write(
|
|
"\n << HelpVariant( tr( \"{}\" ), tr( \"{}\" ),\n QList<HelpArg>()".format(v['variant'], v['variant_description']))
|
|
|
|
if 'arguments' in v:
|
|
for a in v['arguments']:
|
|
cpp.write("\n << HelpArg( QStringLiteral( \"{}\" ), tr( \"{}\" ), {}, {}, {}, {} )".format(
|
|
a['arg'],
|
|
a.get('description', ''),
|
|
"true" if a.get('descOnly', False) else "false",
|
|
"true" if a.get('syntaxOnly', False) else "false",
|
|
"true" if a.get('optional', False) else "false",
|
|
'QStringLiteral( "{}" )'.format(a.get('default', '')) if a.get('default', '') else "QString()"
|
|
)
|
|
)
|
|
|
|
cpp.write(",\n /* variableLenArguments */ {}".format(
|
|
"true" if v.get('variableLenArguments', False) else "false"))
|
|
cpp.write(",\n QList<HelpExample>()")
|
|
|
|
if 'examples' in v:
|
|
for e in v['examples']:
|
|
cpp.write("\n << HelpExample( tr( \"{}\" ), tr( \"{}\" ), tr( \"{}\" ) )".format(
|
|
e['expression'],
|
|
e['returns'],
|
|
e.get('note', ''))
|
|
)
|
|
|
|
if 'notes' in v:
|
|
cpp.write(",\n tr( \"{}\" )".format(v['notes']))
|
|
else:
|
|
cpp.write(",\n QString()")
|
|
|
|
cpp.write(",\n QStringList()")
|
|
if 'tags' in v:
|
|
cpp.write("\n << tr( \"{}\" )".format(",".join(v['tags'])))
|
|
|
|
cpp.write("\n )")
|
|
|
|
cpp.write("\n )")
|
|
cpp.write("\n );")
|
|
|
|
for f in sorted(glob.glob('resources/function_help/text/*')):
|
|
n = os.path.basename(f)
|
|
|
|
with open(f) as content:
|
|
cpp.write("\n\n QgsExpression::functionHelpTexts().insert( \"{0}\",\n Help( tr( \"{0}\" ), tr( \"group\" ), tr( \"{1}\" ), QList<HelpVariant>() ) );\n".format(
|
|
n, content.read().replace("\\", "\").replace('\\', '\\\\').replace('"', '\\"').replace('\n', '\\n')))
|
|
|
|
cpp.write("\n } );\n}\n")
|
|
cpp.close()
|