doxy: preserve internal comment indentation
[u/mrichter/AliRoot.git] / doxygen / thtml2doxy_clang.py
1 #!/usr/bin/env python
2
3 ## @package thtml2doxy_clang
4 #  Translates THtml C++ comments to Doxygen using libclang as parser.
5 #
6 #  This code relies on Python bindings for libclang: libclang's interface is pretty unstable, and
7 #  its Python bindings are unstable as well.
8 #
9 #  AST (Abstract Source Tree) traversal is performed entirely using libclang used as a C++ parser,
10 #  instead of attempting to write a parser ourselves.
11 #
12 #  This code (expecially AST traversal) was inspired by:
13 #
14 #   - [Implementing a code generator with libclang](http://szelei.me/code-generator/)
15 #     (this refers to API calls used here)
16 #   - [Parsing C++ in Python with Clang](http://eli.thegreenplace.net/2011/07/03/parsing-c-in-python-with-clang)
17 #     (outdated, API calls described there do not work anymore, but useful to understand some basic
18 #     concepts)
19 #
20 #  Usage:
21 #
22 #    `thtml2doxy_clang [--stdout|-o] [-d] [--debug=DEBUG_LEVEL] file1 [file2 [file3...]]`
23 #
24 #  Parameters:
25 #
26 #   - `--stdout|-o`: output all on standard output instead of writing files in place
27 #   - `-d`: enable debug mode (very verbose output)
28 #   - `--debug=DEBUG_LEVEL`: set debug level to one of `DEBUG`, `INFO`, `WARNING`, `ERROR`,
29 #     `CRITICAL`
30 #
31 #  @author Dario Berzano, CERN
32 #  @date 2014-12-05
33
34
35 import sys
36 import os
37 import re
38 import logging
39 import getopt
40 import clang.cindex
41
42
43 ## Brain-dead color output for terminal.
44 class Colt(str):
45
46   def red(self):
47     return self.color('\033[31m')
48
49   def green(self):
50     return self.color('\033[32m')
51
52   def yellow(self):
53     return self.color('\033[33m')
54
55   def blue(self):
56     return self.color('\033[34m')
57
58   def magenta(self):
59     return self.color('\033[35m')
60
61   def cyan(self):
62     return self.color('\033[36m')
63
64   def color(self, c):
65     return c + self + '\033[m'
66
67
68 ## Comment.
69 class Comment:
70
71   def __init__(self, lines, first_line, first_col, last_line, last_col, indent, func):
72     self.lines = lines
73     self.first_line = first_line
74     self.first_col = first_col
75     self.last_line = last_line
76     self.last_col = last_col
77     self.indent = indent
78     self.func = func
79
80   def has_comment(self, line):
81     return line >= self.first_line and line <= self.last_line
82
83   def __str__(self):
84     return "<Comment for %s: [%d,%d:%d,%d] %s>" % (self.func, self.first_line, self.first_col, self.last_line, self.last_col, self.lines)
85
86
87 ## A data member comment.
88 class MemberComment:
89
90   def __init__(self, text, is_transient, array_size, first_line, first_col, func):
91     self.lines = [ text ]
92     self.is_transient = is_transient
93     self.array_size = array_size
94     self.first_line = first_line
95     self.first_col = first_col
96     self.func = func
97
98   def has_comment(self, line):
99     return line == self.first_line
100
101   def __str__(self):
102
103     if self.is_transient:
104       tt = '!transient! '
105     else:
106       tt = ''
107
108     if self.array_size is not None:
109       ars = '[%s] ' % self.array_size
110     else:
111       ars = ''
112
113     return "<MemberComment for %s: [%d,%d] %s%s%s>" % (self.func, self.first_line, self.first_col, tt, ars, self.lines[0])
114
115
116 ## A dummy comment that removes comment lines.
117 class RemoveComment(Comment):
118
119   def __init__(self, first_line, last_line):
120     self.first_line = first_line
121     self.last_line = last_line
122     self.func = '<remove>'
123
124   def __str__(self):
125     return "<RemoveComment: [%d,%d]>" % (self.first_line, self.last_line)
126
127
128 ## Parses method comments.
129 #
130 #  @param cursor   Current libclang parser cursor
131 #  @param comments Array of comments: new ones will be appended there
132 def comment_method(cursor, comments):
133
134   # we are looking for the following structure: method -> compound statement -> comment, i.e. we
135   # need to extract the first comment in the compound statement composing the method
136
137   in_compound_stmt = False
138   expect_comment = False
139   emit_comment = False
140
141   comment = []
142   comment_function = cursor.spelling or cursor.displayname
143   comment_line_start = -1
144   comment_line_end = -1
145   comment_col_start = -1
146   comment_col_end = -1
147   comment_indent = -1
148
149   for token in cursor.get_tokens():
150
151     if token.cursor.kind == clang.cindex.CursorKind.COMPOUND_STMT:
152       if not in_compound_stmt:
153         in_compound_stmt = True
154         expect_comment = True
155         comment_line_end = -1
156     else:
157       if in_compound_stmt:
158         in_compound_stmt = False
159         emit_comment = True
160
161     # tkind = str(token.kind)[str(token.kind).index('.')+1:]
162     # ckind = str(token.cursor.kind)[str(token.cursor.kind).index('.')+1:]
163
164     if in_compound_stmt:
165
166       if expect_comment:
167
168         extent = token.extent
169         line_start = extent.start.line
170         line_end = extent.end.line
171
172         if token.kind == clang.cindex.TokenKind.PUNCTUATION and token.spelling == '{':
173           pass
174
175         elif token.kind == clang.cindex.TokenKind.COMMENT and (comment_line_end == -1 or (line_start == comment_line_end+1 and line_end-line_start == 0)):
176           comment_line_end = line_end
177           comment_col_end = extent.end.column
178
179           if comment_indent == -1 or (extent.start.column-1) < comment_indent:
180             comment_indent = extent.start.column-1
181
182           if comment_line_start == -1:
183             comment_line_start = line_start
184             comment_col_start = extent.start.column
185           comment.extend( token.spelling.split('\n') )
186
187           # multiline comments are parsed in one go, therefore don't expect subsequent comments
188           if line_end - line_start > 0:
189             emit_comment = True
190             expect_comment = False
191
192         else:
193           emit_comment = True
194           expect_comment = False
195
196     if emit_comment:
197
198       comment = refactor_comment( comment )
199
200       if len(comment) > 0:
201         logging.debug("Comment found for function %s" % Colt(comment_function).magenta())
202         comments.append( Comment(comment, comment_line_start, comment_col_start, comment_line_end, comment_col_end, comment_indent, comment_function) )
203
204       comment = []
205       comment_line_start = -1
206       comment_line_end = -1
207       comment_col_start = -1
208       comment_col_end = -1
209       comment_indent = -1
210
211       emit_comment = False
212       break
213
214
215 ## Parses comments to class data members.
216 #
217 #  @param cursor   Current libclang parser cursor
218 #  @param comments Array of comments: new ones will be appended there
219 def comment_datamember(cursor, comments):
220
221   # Note: libclang 3.5 seems to have problems parsing a certain type of FIELD_DECL, so we revert
222   # to a partial manual parsing. When parsing fails, the cursor's "extent" is not set properly,
223   # returning a line range 0-0. We therefore make the not-so-absurd assumption that the datamember
224   # definition is fully on one line, and we take the line number from cursor.location.
225
226   line_num = cursor.location.line
227   raw = None
228   prev = None
229   found = False
230
231   # Huge overkill
232   with open(str(cursor.location.file)) as fp:
233     cur_line = 0
234     for raw in fp:
235       cur_line = cur_line + 1
236       if cur_line == line_num:
237         found = True
238         break
239       prev = raw
240
241   assert found, 'A line that should exist was not found in file' % cursor.location.file
242
243   recomm = r'(//(!)|///?)(\[(.*?)\])?<?\s*(.*?)\s*$'
244   recomm_doxyary = r'^\s*///\s*(.*?)\s*$'
245
246   mcomm = re.search(recomm, raw)
247   if mcomm:
248     member_name = cursor.spelling;
249     is_transient = mcomm.group(2) is not None
250     array_size = mcomm.group(4)
251     text = mcomm.group(5)
252
253     col_num = mcomm.start()+1;
254
255     if array_size is not None and prev is not None:
256       # ROOT arrays with comments already converted to Doxygen have the member description on the
257       # previous line
258       mcomm_doxyary = re.search(recomm_doxyary, prev)
259       if mcomm_doxyary:
260         text = mcomm_doxyary.group(1)
261         comments.append(RemoveComment(line_num-1, line_num-1))
262
263     logging.debug('Comment found for member %s' % Colt(member_name).magenta())
264
265     comments.append( MemberComment(
266       text,
267       is_transient,
268       array_size,
269       line_num,
270       col_num,
271       member_name ))
272
273   else:
274     assert False, 'Regular expression does not match member comment'
275
276
277 ## Parses class description (beginning of file).
278 #
279 #  The clang parser does not work in this case so we do it manually, but it is very simple: we keep
280 #  the first consecutive sequence of single-line comments (//) we find - provided that it occurs
281 #  before any other comment found so far in the file (the comments array is inspected to ensure
282 #  this).
283 #
284 #  Multi-line comments (/* ... */) are not considered as they are commonly used to display
285 #  copyright notice.
286 #
287 #  @param filename Name of the current file
288 #  @param comments Array of comments: new ones will be appended there
289 def comment_classdesc(filename, comments):
290
291   recomm = r'^\s*///?\s*(.*?)\s*/*\s*$'
292
293   reclass_doxy = r'(?i)^\\class:?\s*(.*?)\s*$'
294   class_name_doxy = None
295
296   reauthor = r'(?i)\\?authors?:?\s*(.*?)\s*(,?\s*([0-9./-]+))?\s*$'
297   redate = r'(?i)\\?date:?\s*([0-9./-]+)'
298   author = None
299   date = None
300
301   comment_lines = []
302
303   start_line = -1
304   end_line = -1
305
306   line_num = 0
307
308   with open(filename, 'r') as fp:
309
310     for raw in fp:
311
312       line_num = line_num + 1
313
314       if raw.strip() == '':
315         # Skip empty lines
316         end_line = line_num - 1
317         continue
318
319       mcomm = re.search(recomm, raw)
320       if mcomm:
321
322         if start_line == -1 and len(comment_lines) == 0:
323
324           # First line. Check that we do not overlap with other comments
325           comment_overlaps = False
326           for c in comments:
327             if c.has_comment(line_num):
328               comment_overlaps = True
329               break
330
331           if comment_overlaps:
332             # No need to look for other comments
333             break
334
335           start_line = line_num
336
337         append = True
338
339         mclass_doxy = re.search(reclass_doxy, mcomm.group(1))
340         if mclass_doxy:
341           class_name_doxy = mclass_doxy.group(1)
342           append = False
343         else:
344           mauthor = re.search(reauthor, mcomm.group(1))
345           if mauthor:
346             author = mauthor.group(1)
347             if date is None:
348               # Date specified in the standalone \date field has priority
349               date = mauthor.group(2)
350             append = False
351           else:
352             mdate = re.search(redate, mcomm.group(1))
353             if mdate:
354               date = mdate.group(1)
355               append = False
356
357         if append:
358           comment_lines.append( mcomm.group(1) )
359
360       else:
361         if len(comment_lines) > 0:
362           # End of our comment
363           if end_line == -1:
364             end_line = line_num - 1
365           break
366
367   if class_name_doxy is None:
368
369     # No \class specified: guess it from file name
370     reclass = r'^(.*/)?(.*?)(\..*)?$'
371     mclass = re.search( reclass, filename )
372     if mclass:
373       class_name_doxy = mclass.group(2)
374     else:
375       assert False, 'Regexp unable to extract classname from file'
376
377   # Prepend \class specifier (and an empty line)
378   comment_lines[:0] = [ '\\class ' + class_name_doxy ]
379
380   # Append author and date if they exist
381   comment_lines.append('')
382
383   if author is not None:
384     comment_lines.append( '\\author ' + author )
385
386   if date is not None:
387     comment_lines.append( '\\date ' + date )
388
389   comment_lines = refactor_comment(comment_lines)
390   logging.debug('Comment found for class %s' % Colt(class_name_doxy).magenta())
391   comments.append(Comment(
392     comment_lines,
393     start_line, 1, end_line, 1,
394     0, class_name_doxy
395   ))
396
397
398 ## Traverse the AST recursively starting from the current cursor.
399 #
400 #  @param cursor    A Clang parser cursor
401 #  @param filename  Name of the current file
402 #  @param comments  Array of comments: new ones will be appended there
403 #  @param recursion Current recursion depth
404 def traverse_ast(cursor, filename, comments, recursion=0):
405
406   # libclang traverses included files as well: we do not want this behavior
407   if cursor.location.file is not None and str(cursor.location.file) != filename:
408     logging.debug("Skipping processing of included %s" % cursor.location.file)
409     return
410
411   text = cursor.spelling or cursor.displayname
412   kind = str(cursor.kind)[str(cursor.kind).index('.')+1:]
413
414   indent = ''
415   for i in range(0, recursion):
416     indent = indent + '  '
417
418   if cursor.kind == clang.cindex.CursorKind.CXX_METHOD or cursor.kind == clang.cindex.CursorKind.CONSTRUCTOR or cursor.kind == clang.cindex.CursorKind.DESTRUCTOR:
419
420     # cursor ran into a C++ method
421     logging.debug( "%5d %s%s(%s)" % (cursor.location.line, indent, Colt(kind).magenta(), Colt(text).blue()) )
422     comment_method(cursor, comments)
423
424   elif cursor.kind == clang.cindex.CursorKind.FIELD_DECL:
425
426     # cursor ran into a data member declaration
427     logging.debug( "%5d %s%s(%s)" % (cursor.location.line, indent, Colt(kind).magenta(), Colt(text).blue()) )
428     comment_datamember(cursor, comments)
429
430   else:
431
432     logging.debug( "%5d %s%s(%s)" % (cursor.location.line, indent, kind, text) )
433
434   for child_cursor in cursor.get_children():
435     traverse_ast(child_cursor, filename, comments, recursion+1)
436
437   if recursion == 0:
438     comment_classdesc(filename, comments)
439
440
441 ## Strip some HTML tags from the given string. Returns clean string.
442 #
443 #  @param s Input string
444 def strip_html(s):
445   rehtml = r'(?i)</?(P|H[0-9]|BR)/?>'
446   return re.sub(rehtml, '', s)
447
448
449 ## Remove garbage from comments and convert special tags from THtml to Doxygen.
450 #
451 #  @param comment An array containing the lines of the original comment
452 def refactor_comment(comment, do_strip_html=True):
453
454   recomm = r'^(/{2,}|/\*)? ?(\s*.*?)\s*((/{2,})?\s*|\*/)$'
455   regarbage = r'^(?i)\s*([\s*=-_#]+|(Begin|End)_Html)\s*$'
456
457   new_comment = []
458   insert_blank = False
459   wait_first_non_blank = True
460   for line_comment in comment:
461
462     # Strip some HTML tags
463     if do_strip_html:
464       line_comment = strip_html(line_comment)
465
466     mcomm = re.search( recomm, line_comment )
467     if mcomm:
468       new_line_comment = mcomm.group(2)
469       mgarbage = re.search( regarbage, new_line_comment )
470
471       if new_line_comment == '' or mgarbage is not None:
472         insert_blank = True
473       else:
474         if insert_blank and not wait_first_non_blank:
475           new_comment.append('')
476         insert_blank = False
477         wait_first_non_blank = False
478         new_comment.append( new_line_comment )
479
480     else:
481       assert False, 'Comment regexp does not match'
482
483   return new_comment
484
485
486 ## Rewrites all comments from the given file handler.
487 #
488 #  @param fhin     The file handler to read from
489 #  @param fhout    The file handler to write to
490 #  @param comments Array of comments
491 def rewrite_comments(fhin, fhout, comments):
492
493   line_num = 0
494   in_comment = False
495   skip_empty = False
496   comm = None
497   prev_comm = None
498
499   rindent = r'^(\s*)'
500
501   for line in fhin:
502
503     line_num = line_num + 1
504
505     # Find current comment
506     prev_comm = comm
507     comm = None
508     for c in comments:
509       if c.has_comment(line_num):
510         comm = c
511
512     if comm:
513
514       if isinstance(comm, MemberComment):
515         non_comment = line[ 0:comm.first_col-1 ]
516
517         if comm.array_size is not None:
518
519           mindent = re.search(rindent, line)
520           if comm.is_transient:
521             tt = '!'
522           else:
523             tt = ''
524
525           # Special case: we need multiple lines not to confuse ROOT's C++ parser
526           fhout.write('%s/// %s\n%s//%s[%s]\n' % (
527             mindent.group(1),
528             comm.lines[0],
529             non_comment,
530             tt,
531             comm.array_size
532           ))
533
534         else:
535
536           if comm.is_transient:
537             tt = '!'
538           else:
539             tt = '/'
540
541           fhout.write('%s//%s< %s\n' % (
542             non_comment,
543             tt,
544             comm.lines[0]
545           ))
546
547       elif isinstance(comm, RemoveComment):
548         # Do nothing: just skip line
549         pass
550
551       elif prev_comm is None:
552         # Beginning of a new comment block of type Comment
553         in_comment = True
554
555         # Extract the non-comment part and print it if it exists
556         non_comment = line[ 0:comm.first_col-1 ].rstrip()
557         if non_comment != '':
558           fhout.write( non_comment + '\n' )
559
560     else:
561
562       if in_comment:
563
564         # We have just exited a comment block of type Comment
565         in_comment = False
566
567         # Dump revamped comment, if applicable
568         text_indent = ''
569         for i in range(0,prev_comm.indent):
570           text_indent = text_indent + ' '
571
572         for lc in prev_comm.lines:
573           fhout.write( "%s/// %s\n" % (text_indent, lc) );
574         fhout.write('\n')
575         skip_empty = True
576
577       line_out = line.rstrip('\n')
578       if skip_empty:
579         skip_empty = False
580         if line_out.strip() != '':
581           fhout.write( line_out + '\n' )
582       else:
583         fhout.write( line_out + '\n' )
584
585
586 ## The main function.
587 #
588 #  Return value is the executable's return value.
589 def main(argv):
590
591   # Setup logging on stderr
592   log_level = logging.INFO
593   logging.basicConfig(
594     level=log_level,
595     format='%(levelname)-8s %(funcName)-20s %(message)s',
596     stream=sys.stderr
597   )
598
599   # Parse command-line options
600   output_on_stdout = False
601   try:
602     opts, args = getopt.getopt( argv, 'od', [ 'debug=', 'stdout' ] )
603     for o, a in opts:
604       if o == '--debug':
605         log_level = getattr( logging, a.upper(), None )
606         if not isinstance(log_level, int):
607           raise getopt.GetoptError('log level must be one of: DEBUG, INFO, WARNING, ERROR, CRITICAL')
608       elif o == '-d':
609         log_level = logging.DEBUG
610       elif o == '-o' or o == '--stdout':
611         logging.debug('Output on stdout instead of replacing original files')
612         output_on_stdout = True
613       else:
614         assert False, 'Unhandled argument'
615   except getopt.GetoptError as e:
616     logging.fatal('Invalid arguments: %s' % e)
617     return 1
618
619   logging.getLogger('').setLevel(log_level)
620
621   # Attempt to load libclang from a list of known locations
622   libclang_locations = [
623     '/usr/lib/llvm-3.5/lib/libclang.so.1',
624     '/usr/lib/libclang.so',
625     '/Library/Developer/CommandLineTools/usr/lib/libclang.dylib'
626   ]
627   libclang_found = False
628
629   for lib in libclang_locations:
630     if os.path.isfile(lib):
631       clang.cindex.Config.set_library_file(lib)
632       libclang_found = True
633       break
634
635   if not libclang_found:
636     logging.fatal('Cannot find libclang')
637     return 1
638
639   # Loop over all files
640   for fn in args:
641
642     logging.info('Input file: %s' % Colt(fn).magenta())
643     index = clang.cindex.Index.create()
644     translation_unit = index.parse(fn, args=['-x', 'c++'])
645
646     comments = []
647     traverse_ast( translation_unit.cursor, fn, comments )
648     for c in comments:
649
650       logging.debug("Comment found for entity %s:" % Colt(c.func).magenta())
651
652       if isinstance(c, MemberComment):
653
654         if c.is_transient:
655           transient_text = Colt('transient ').yellow()
656         else:
657           transient_text = ''
658
659         if c.array_size is not None:
660           array_text = Colt('arraysize=%s ' % c.array_size).yellow()
661         else:
662           array_text = ''
663
664         logging.debug(
665           "%s %s%s{%s}" % ( \
666             Colt("[%d,%d]" % (c.first_line, c.first_col)).green(),
667             transient_text,
668             array_text,
669             Colt(c.lines[0]).cyan()
670         ))
671
672       elif isinstance(c, RemoveComment):
673
674         logging.debug( Colt('[%d,%d]' % (c.first_line, c.last_line)).green() )
675
676       else:
677         for l in c.lines:
678           logging.debug(
679             Colt("[%d,%d:%d,%d] " % (c.first_line, c.first_col, c.last_line, c.last_col)).green() +
680             "{%s}" % Colt(l).cyan()
681           )
682
683     try:
684
685       if output_on_stdout:
686         with open(fn, 'r') as fhin:
687           rewrite_comments( fhin, sys.stdout, comments )
688       else:
689         fn_back = fn + '.thtml2doxy_backup'
690         os.rename( fn, fn_back )
691
692         with open(fn_back, 'r') as fhin, open(fn, 'w') as fhout:
693           rewrite_comments( fhin, fhout, comments )
694
695         os.remove( fn_back )
696         logging.info("File %s converted to Doxygen: check differences before committing!" % Colt(fn).magenta())
697     except (IOError,OSError) as e:
698       logging.error('File operation failed: %s' % e)
699
700   return 0
701
702
703 if __name__ == '__main__':
704   sys.exit( main( sys.argv[1:] ) )