data/utilities/extractBrief.py.in

   1 #!@PYTHON_EXECUTABLE@
   2 #-------------------------------------------------------------------------------
   3 #               ______                _     ____          __  __
   4 #              |  ____|             _| |_  / __ \   /\   |  \/  |
   5 #              | |__ _ __ ___  ___ /     \| |  | | /  \  | \  / |
   6 #              |  __| '__/ _ \/ _ ( (| |) ) |  | |/ /\ \ | |\/| |
   7 #              | |  | | |  __/  __/\_   _/| |__| / ____ \| |  | |
   8 #              |_|  |_|  \___|\___|  |_|   \____/_/    \_\_|  |_|
   9 #
  10 #                   FreeFOAM: The Cross-Platform CFD Toolkit
  11 #
  12 # Copyright (C) 2008-2010 Michael Wild <themiwi@users.sf.net>
  13 #                         Gerber van der Graaf <gerber_graaf@users.sf.net>
  14 #-------------------------------------------------------------------------------
  15 # License
  16 #   This file is part of FreeFOAM.
  17 #
  18 #   FreeFOAM is free software; you can redistribute it and/or modify it
  19 #   under the terms of the GNU General Public License as published by the
  20 #   Free Software Foundation; either version 2 of the License, or (at your
  21 #   option) any later version.
  22 #
  23 #   FreeFOAM is distributed in the hope that it will be useful, but WITHOUT
  24 #   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  25 #   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  26 #   for more details.
  27 #
  28 #   You should have received a copy of the GNU General Public License
  29 #   along with FreeFOAM; if not, write to the Free Software Foundation,
  30 #   Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  31 #
  32 # Script
  33 #    extractBrief
  34 #
  35 # Description
  36 #    Extracts the brief description from the header comment of an application
  37 #    source file and converts it to AsciiDoc code. The output is written to
  38 #    standard output.
  39 #
  40 #------------------------------------------------------------------------------
  41
  42 """Usage: extractBrief@PY_SCRIPT_SUFFIX@ <name> <file>
  43
  44 Extracts the brief description from the header comment of an application
  45 source file and converts it to AsciiDoc code. The output is written to
  46 standard output.
  47
  48 Options
  49 -------
  50 -h
  51 -help               Display this help message
  52 <name>              Name of the application.
  53 <file>              The source file to to process.
  54
  55 """
  56
  57 import sys
  58 import os.path
  59 sys.path.insert(0, '@FOAM_PYTHON_DIR@')
  60 import FreeFOAM.doxyToAsciidoc
  61 from FreeFOAM.compat import *
  62
  63 args = sys.argv[1:]
  64 while len(args) > 0:
  65    a = args[0]
  66    if a == '-h' or a == '-help':
  67       echo(__doc__)
  68       sys.exit(0)
  69    else:
  70       break
  71
  72 if len(args) != 2:
  73    echo('Error: the name and input file required arguments', file=sys.stderr)
  74    sys.exit(1)
  75
  76 name = args[0]
  77 source = args[1]
  78
  79 if not os.path.isfile(source):
  80    echo('Error: "%s" does not exist or is not a file'%source, file=sys.stderr)
  81    sys.exit(1)
  82
  83 # parse the header comments
  84 doc = FreeFOAM.doxyToAsciidoc.Parser(source).parse()
  85 brief = ' '.join(doc['brief']).strip()
  86 if brief[-1] != '.':
  87    brief += '.'
  88
  89 echo('*linkff:%s[1]*::\n  %s'%(name, brief))
  90
  91 # ------------------------- vim: set sw=3 sts=3 et: --------------- end-of-file