# before any other comment found so far in the file (the comments array is inspected to ensure
# this).
#
-# Multi-line comments (/* ... */) are not considered as they are commonly used to display
-# copyright notice.
+# Multi-line comments (/* ... */) that *immediately* follow a series of single-line comments
+# (*i.e.* without empty lines in-between) are also considered. A class description can eventually
+# be a series of single-line and multi-line comments, with no blank spaces between them, and always
+# starting with a single-line sequence.
+#
+# The reason why they cannot start with a multi-line sequence is that those are commonly used to
+# display a copyright notice.
#
# @param filename Name of the current file
# @param comments Array of comments: new ones will be appended there
# @param look_no_further_than_line Stop before reaching this line when looking for class comment
def comment_classdesc(filename, comments, look_no_further_than_line):
+ # Single-line comment
recomm = r'^\s*///?(\s*(.*?))\s*/*\s*$'
+ # Multi-line comment (only either /* or */ on a single line)
+ remlcomm_in = r'^\s*/\*\s*$'
+ remlcomm_out = r'^\s*\*/\s*$'
+ in_mlcomm = False
+
reclass_doxy = r'(?i)^\s*\\(class|file):?\s*([^.]*)'
class_name_doxy = None
end_line = -1
line_num = 0
+ last_comm_line_num = 0
is_macro = filename.endswith('.C')
look_no_further_than_line)
break
- if raw.strip() == '' and start_line > 0:
+ if in_mlcomm == False and raw.strip() == '' and start_line > 0:
# Skip empty lines
continue
end_line = line_num
append = True
- mclass_doxy = re.search(reclass_doxy, mcomm.group(1))
+ mclass_doxy = re.search(reclass_doxy, this_comment)
if mclass_doxy:
class_name_doxy = mclass_doxy.group(2)
append = False
else:
- mauthor = re.search(reauthor, mcomm.group(1))
+ mauthor = re.search(reauthor, this_comment)
if mauthor:
author = mauthor.group(2)
if date is None:
date = mauthor.group(4)
append = False
else:
- mdate = re.search(redate, mcomm.group(1))
+ mdate = re.search(redate, this_comment)
if mdate:
date = mdate.group(1)
append = False
else:
- mbrief = re.search(rebrief, mcomm.group(1))
+ mbrief = re.search(rebrief, this_comment)
if mbrief:
brief = mbrief.group(1)
append = False
if append:
- comment_lines.append( mcomm.group(1) )
+ comment_lines.append( this_comment )
else:
if start_line > 0:
break
+ # This line had a valid comment
+ last_comm_line_num = line_num
+
if class_name_doxy is None:
# No \class specified: guess it from file name
if date is not None:
comment_lines.append( '\\date ' + date )
+ # We should erase the "dumb" comments, such as "<class_name> class"
+ comm_idx = 0
+ regac = r'\s*%s\s+class\.?\s*' % class_name_doxy
+ mgac = None
+ for comm in comment_lines:
+ mgac = re.search(regac, comm)
+ if mgac:
+ break
+ comm_idx = comm_idx + 1
+ if mgac:
+ logging.debug('Removing dumb comment line: {%s}' % Colt(comment_lines[comm_idx]).magenta())
+ del comment_lines[comm_idx]
+
comment_lines = refactor_comment(comment_lines, do_strip_html=False, infilename=filename)
# Now we look for a possible \brief
with open(filename, 'r') as fp:
- for line in fp:
+ # Array of tuples: classimp, startcond, endcond
+ found_classimp = []
- # Reset to nothing found
- line_classimp = -1
- line_startcond = -1
- line_endcond = -1
- classimp_class = None
- classimp_indent = None
+ # Reset to nothing found
+ line_classimp = -1
+ line_startcond = -1
+ line_endcond = -1
+ classimp_class = None
+ classimp_indent = None
+
+ for line in fp:
line_num = line_num + 1
mclassimp = re.search(reclassimp, line)
if mclassimp:
+ # Dump previous one if appropriate, and reset
+ if line_classimp != -1:
+ found_classimp.append( (line_classimp, line_startcond, line_endcond) )
+ line_classimp = -1
+ line_startcond = -1
+ line_endcond = -1
+
# Adjust indent
classimp_indent = len( mclassimp.group(1) )
mstartcond = re.search(restartcond, line)
if mstartcond:
- logging.debug('Found Doxygen opening condition for ClassImp in {%s}' % line)
+
+ # Dump previous one if appropriate, and reset
+ if line_classimp != -1:
+ found_classimp.append( (line_classimp, line_startcond, line_endcond) )
+ line_classimp = -1
+ line_startcond = -1
+ line_endcond = -1
+
+ logging.debug('Found Doxygen opening condition for ClassImp')
in_classimp_cond = True
line_startcond = line_num
in_classimp_cond = False
line_endcond = line_num
- # Did we find something?
- if line_classimp != -1:
+ # Dump previous one if appropriate, and reset (out of the loop)
+ if line_classimp != -1:
+ found_classimp.append( (line_classimp, line_startcond, line_endcond) )
+ line_classimp = -1
+ line_startcond = -1
+ line_endcond = -1
- if line_startcond != -1:
- comments.append(Comment(
- ['\cond CLASSIMP'],
- line_startcond, 1, line_startcond, 1,
- classimp_indent, 'ClassImp/Def(%s)' % classimp_class,
- append_empty=False
- ))
- else:
- comments.append(PrependComment(
- ['\cond CLASSIMP'],
- line_classimp, 1, line_classimp, 1,
- classimp_indent, 'ClassImp/Def(%s)' % classimp_class
- ))
+ for line_classimp,line_startcond,line_endcond in found_classimp:
- if line_endcond != -1:
- comments.append(Comment(
- ['\endcond'],
- line_endcond, 1, line_endcond, 1,
- classimp_indent, 'ClassImp/Def(%s)' % classimp_class,
- append_empty=False
- ))
- else:
- comments.append(PrependComment(
- ['\endcond'],
- line_classimp+1, 1, line_classimp+1, 1,
- classimp_indent, 'ClassImp/Def(%s)' % classimp_class
- ))
+ # Loop over the ClassImp conditions we've found
+
+ if line_startcond != -1:
+ logging.debug('Looks like we are in a condition here %d,%d,%d' % (line_classimp, line_startcond, line_endcond))
+ comments.append(Comment(
+ ['\cond CLASSIMP'],
+ line_startcond, 1, line_startcond, 1,
+ classimp_indent, 'ClassImp/Def(%s)' % classimp_class,
+ append_empty=False
+ ))
+ else:
+ logging.debug('Looks like we are NOT NOT in a condition here %d,%d,%d' % (line_classimp, line_startcond, line_endcond))
+ comments.append(PrependComment(
+ ['\cond CLASSIMP'],
+ line_classimp, 1, line_classimp, 1,
+ classimp_indent, 'ClassImp/Def(%s)' % classimp_class
+ ))
+
+ if line_endcond != -1:
+ comments.append(Comment(
+ ['\endcond'],
+ line_endcond, 1, line_endcond, 1,
+ classimp_indent, 'ClassImp/Def(%s)' % classimp_class,
+ append_empty=False
+ ))
+ else:
+ comments.append(PrependComment(
+ ['\endcond'],
+ line_classimp+1, 1, line_classimp+1, 1,
+ classimp_indent, 'ClassImp/Def(%s)' % classimp_class
+ ))
## Traverse the AST recursively starting from the current cursor.
wait_first_non_blank = True
for line_comment in comment:
- # Check if we are in a macro block
- mmacro = re.search(remacro, line_comment)
- if mmacro:
- if in_macro:
- in_macro = False
-
- # Dump macro
- outimg = write_macro(infilename, current_macro) + '.png'
- current_macro = []
-
- # Insert image
- new_comment.append( '' % (os.path.basename(outimg)) )
-
- logging.debug( 'Found macro for generating image %s' % Colt(outimg).magenta() )
-
- else:
- in_macro = True
-
- continue
- elif in_macro:
- current_macro.append( line_comment )
- continue
-
# Strip some HTML tags
if do_strip_html:
line_comment = strip_html(line_comment)
if mcomm:
new_line_comment = mcomm.group(2) + mcomm.group(3) # indent + comm
+ # Check if we are in a macro block
+ mmacro = re.search(remacro, new_line_comment)
+ if mmacro:
+ if in_macro:
+ in_macro = False
+
+ # Dump macro
+ outimg = write_macro(infilename, current_macro) + '.png'
+ current_macro = []
+
+ # Insert image
+ new_comment.append( '' % (os.path.basename(outimg)) )
+
+ logging.debug( 'Found macro for generating image %s' % Colt(outimg).magenta() )
+
+ else:
+ in_macro = True
+
+ continue
+ elif in_macro:
+ current_macro.append( new_line_comment )
+ continue
+
mgarbage = re.search( regarbage, new_line_comment )
if mgarbage is None and not mcomm.group(3).startswith('\\') and mcomm.group(3) != '':
digh.update('\n')
short_digest = digh.hexdigest()[0:7]
- outdir = '%s/imgdoc' % os.path.dirname(infilename)
+ infiledir = os.path.dirname(infilename)
+ if infiledir == '':
+ infiledir = '.'
+ outdir = '%s/imgdoc' % infiledir
outprefix = '%s/%s_%s' % (
outdir,
os.path.basename(infilename).replace('.', '_'),
restore_lines = [ line.rstrip('\n') ]
logging.debug('Commencing lines to restore: {%s}' % Colt(restore_lines[0]).cyan())
else:
- # Extract the non-comment part and print it if it exists
- non_comment = line[ 0:comm.first_col-1 ].rstrip()
- if non_comment != '':
- fhout.write( non_comment + '\n' )
+ # Extract the non-comment part and print it if it exists. If this is the first line of a
+ # comment, it might happen something like `valid_code; // this is a comment`.
+ if comm.first_line == line_num:
+ non_comment = line[ 0:comm.first_col-1 ].rstrip()
+ if non_comment != '':
+ fhout.write( non_comment + '\n' )
elif isinstance(comm, Comment):
git://git.uio.no / u / mrichter / AliRoot.git / blobdiff