scripts/create_tags_helper.py

   1 #!/usr/bin/env python3
   2 #
   3 # Author:  The Geany contributors
   4 # License: GPL v2 or later
   5 #
   6 # This is a helper library for Python scripts to create tag files in ctags format,
   7 # e.g. create_py_tags.py and create_php_tags.py.
   8 #
   9
  10 import datetime
  11 import platform
  12
  13
  14 CTAGS_FILE_HEADER = '''!_TAG_FILE_FORMAT        2       /extended format; --format=1 will not append ;" to lines/
  15 !_TAG_FILE_SORTED       1       /0=unsorted, 1=sorted, 2=foldcase/
  16 !_TAG_OUTPUT_EXCMD      mixed   /number, pattern, mixed, or combineV2/
  17 !_TAG_OUTPUT_FILESEP    slash   /slash or backslash/
  18 !_TAG_OUTPUT_MODE       u-ctags /u-ctags or e-ctags/
  19 !_TAG_PATTERN_LENGTH_LIMIT      96      /0 for no limit/
  20 !_TAG_PROGRAM_NAME {program_name} Automatically generated file - do not edit (created on {timestamp} with Python {python_version})
  21 '''
  22
  23
  24 def format_tag(tagname, kind, signature, parent, return_type=None):
  25     """
  26     @param tagname (str)
  27     @param kind (str)
  28     @param signature (str)
  29     @param parent (str)
  30     @param return_type (tuple of two elements or None)
  31
  32     """
  33     if signature:
  34         signature_field = f'\tsignature:{signature}'
  35     else:
  36         signature_field = ''
  37
  38     if parent:
  39         parent_field = f'\tclass:{parent}'
  40     else:
  41         parent_field = ''
  42
  43     if return_type:
  44         return_type_field = f'\ttyperef:{return_type[0]}:{return_type[1]}'
  45     else:
  46         return_type_field = ''
  47
  48     return f'{tagname}\t/unknown\t1;"\tkind:{kind}{parent_field}{signature_field}{return_type_field}\n'
  49
  50
  51 def write_ctags_file(filename, tags, program_name):
  52     """
  53     Sort the found tags and write them into the file specified by filename
  54
  55     @param filename (str)
  56     @param tags (list)
  57     @param program_name (str)
  58     """
  59     result = sorted(tags)
  60
  61     ctags_file_header = CTAGS_FILE_HEADER.format(
  62         program_name=program_name,
  63         timestamp=datetime.datetime.now().ctime(),
  64         python_version=platform.python_version())
  65
  66     with open(filename, 'w', encoding='utf-8') as target_file:
  67         target_file.write(ctags_file_header)
  68         for symbol in result:
  69             if symbol != '\n':  # skip empty lines
  70                 target_file.write(symbol)