nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-27 22:03:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

add_c_file: Simplify some usage of srcdir_file()

Browse Source 
Part of 32962.
This commit is contained in:
teor 2020-01-16 08:55:20 +10:00
parent 3d50efcf98
commit b828588499
No known key found for this signature in database
GPG Key ID: 10FEAA0E7075672A
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
scripts/maint/add_c_file.py
View File

@ -41,12 +41,11 @@ def srcdir_file(name):
but outputs a path that is relative to tor's src directory.)""" but outputs a path that is relative to tor's src directory.)"""
return os.path.normpath(os.path.relpath(name, 'src')) return os.path.normpath(os.path.relpath(name, 'src'))
def guard_macro(name): def guard_macro(src_fname):
"""Return the guard macro that should be used for the header file 'name'. """Return the guard macro that should be used for the header file
This function takes paths relative to the top-level tor directory, 'src_fname'. This function takes paths relative to tor's src directory.
but its output is relative to tor's src directory.
""" """
td = srcdir_file(name).replace(".", "_").replace("/", "_").upper() td = src_fname.replace(".", "_").replace("/", "_").upper()
return "TOR_{}".format(td) return "TOR_{}".format(td)
def makeext(name, new_extension): def makeext(name, new_extension):
@ -58,26 +57,27 @@ def makeext(name, new_extension):
base = os.path.splitext(name)[0] base = os.path.splitext(name)[0]
return base + "." + new_extension return base + "." + new_extension
def instantiate_template(template, output_fname): def instantiate_template(template, tor_fname):
""" """
Fill in a template with string using the fields that should be used Fill in a template with string using the fields that should be used
for 'output_fname'. for 'tor_fname'.
This function takes paths relative to the top-level tor directory, This function takes paths relative to the top-level tor directory,
but the paths in the completed template are relative to tor's src but the paths in the completed template are relative to tor's src
directory. (Except for one of the fields, which is just a basename). directory. (Except for one of the fields, which is just a basename).
""" """
src_fname = srcdir_file(tor_fname)
names = { names = {
# The relative location of the header file. # The relative location of the header file.
'header_path' : makeext(srcdir_file(output_fname), "h"), 'header_path' : makeext(src_fname, "h"),
# The relative location of the C file file. # The relative location of the C file file.
'c_file_path' : makeext(srcdir_file(output_fname), "c"), 'c_file_path' : makeext(src_fname, "c"),
# The truncated name of the file. # The truncated name of the file.
'short_name' : os.path.basename(output_fname), 'short_name' : os.path.basename(src_fname),
# The current year, for the copyright notice # The current year, for the copyright notice
'this_year' : time.localtime().tm_year, 'this_year' : time.localtime().tm_year,
# An appropriate guard macro, for the header. # An appropriate guard macro, for the header.
'guard_macro' : guard_macro(output_fname), 'guard_macro' : guard_macro(src_fname),
} }
return template.format(**names) return template.format(**names)