13
0
livetrax/tools/doxy2json/doxy2json.cc

369 lines
9.1 KiB
C++
Raw Normal View History

/* extract doxygen comments from C++ header files
*
* Copyright (C) 2016 Robin Gareus <robin@gareus.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <stdlib.h>
#include <unistd.h>
#include <getopt.h>
2016-04-11 10:16:52 -04:00
#include <pthread.h>
#include <cstdio>
#include <cstring>
#include <sstream>
#include <iomanip>
2016-04-11 10:16:52 -04:00
#include <algorithm>
#include <map>
2016-04-11 10:16:52 -04:00
#include <vector>
#include <clang-c/Index.h>
#include <clang-c/Documentation.h>
2016-04-11 10:16:52 -04:00
struct Dox2jsConfig {
Dox2jsConfig () : clang_argc (3), clang_argv (0), excl_argc (0), excl_argv (0)
{
excl_argv = (char**) calloc (1, sizeof (char*));
clang_argv = (char**) malloc (clang_argc * sizeof (char*));
clang_argv[0] = strdup ("-x");
clang_argv[1] = strdup ("c++");
clang_argv[2] = strdup ("-std=c++11");
}
2016-04-11 10:16:52 -04:00
~Dox2jsConfig () {
for (int i = 0; i < clang_argc; ++i) {
free (clang_argv[i]);
}
for (int i = 0; excl_argv[i]; ++i) {
free (excl_argv[i]);
}
free (clang_argv);
free (excl_argv);
}
void add_clang_arg (const char *a) {
clang_argv = (char**) realloc (clang_argv, (clang_argc + 1) * sizeof (char*));
clang_argv[clang_argc++] = strdup (a);
}
void add_exclude (const char *a) {
excl_argv = (char**) realloc (excl_argv, (excl_argc + 2) * sizeof (char*));
excl_argv[excl_argc++] = strdup (a);
excl_argv[excl_argc] = NULL;
}
int clang_argc;
char** clang_argv;
int excl_argc;
char** excl_argv;
};
2016-04-11 10:16:52 -04:00
typedef std::map <std::string, std::string> ResultMap;
struct dox2js {
Dox2jsConfig *cfg;
ResultMap results;
};
struct ProcessQueue {
ProcessQueue (std::vector<char*>* files, ResultMap* r, Dox2jsConfig* c, pthread_mutex_t* lck, bool report, bool check)
: fq (files)
, rm (r)
, djc (c)
, lock (lck)
, total (files->size ())
, done (0)
, report_progress (report)
, check_compile (check)
{ }
std::vector<char*>* fq;
ResultMap *rm;
Dox2jsConfig *djc;
pthread_mutex_t* lock;
unsigned int total;
unsigned int done;
bool report_progress;
bool check_compile;
};
static const char*
kind_to_txt (CXCursor cursor)
{
CXCursorKind kind = clang_getCursorKind (cursor);
switch (kind) {
case CXCursor_StructDecl : return "Struct";
case CXCursor_EnumDecl : return "Enum";
case CXCursor_UnionDecl : return "Union";
case CXCursor_FunctionDecl : return "C Function";
case CXCursor_VarDecl : return "Variable";
case CXCursor_ClassDecl : return "C++ Class";
case CXCursor_CXXMethod : return "C++ Method";
case CXCursor_Namespace : return "C++ Namespace";
case CXCursor_Constructor : return "C++ Constructor";
case CXCursor_Destructor : return "C++ Destructor";
case CXCursor_FieldDecl : return "Data Member/Field";
default: break;
}
return "";
}
static std::string
escape_json (const std::string &s)
{
std::ostringstream o;
for (auto c = s.cbegin (); c != s.cend (); c++) {
switch (*c) {
case '"': o << "\\\""; break;
case '\\': o << "\\\\"; break;
case '\n': o << "\\n"; break;
case '\r': o << "\\r"; break;
case '\t': o << "\\t"; break;
default:
if ('\x00' <= *c && *c <= '\x1f') {
o << "\\u" << std::hex << std::setw (4) << std::setfill ('0') << (int)*c;
} else {
o << *c;
}
}
}
return o.str ();
}
static std::string
recurse_parents (CXCursor cr) {
std::string rv;
CXCursor pc = clang_getCursorSemanticParent (cr);
if (CXCursor_TranslationUnit == clang_getCursorKind (pc)) {
return rv;
}
if (!clang_Cursor_isNull (pc)) {
rv += recurse_parents (pc);
rv += clang_getCString (clang_getCursorDisplayName (pc));
rv += "::";
}
return rv;
}
static bool
check_excludes (const std::string& decl, CXClientData d) {
2016-04-11 10:16:52 -04:00
struct Dox2jsConfig* djc = (struct Dox2jsConfig*) d;
char** excl = djc->excl_argv;
for (int i = 0; excl[i]; ++i) {
if (decl.compare (0, strlen (excl[i]), excl[i]) == 0) {
return true;
}
}
return false;
}
static enum CXChildVisitResult
traverse (CXCursor cr, CXCursor /*parent*/, CXClientData d)
{
struct dox2js* dj = (struct dox2js*) d;
CXComment c = clang_Cursor_getParsedComment (cr);
if (clang_Comment_getKind (c) != CXComment_Null
&& clang_isDeclaration (clang_getCursorKind (cr))
&& 0 != strlen (kind_to_txt (cr))
) {
// TODO: resolve typedef enum { .. } name;
// use clang_getCursorDefinition (clang_getCanonicalCursor (cr)) ??
std::string decl = recurse_parents (cr);
decl += clang_getCString (clang_getCursorDisplayName (cr));
2016-04-11 10:16:52 -04:00
if (decl.empty () || check_excludes (decl, dj->cfg)) {
return CXChildVisit_Recurse;
}
std::ostringstream o;
o << "{ \"decl\" : \"" << decl << "\",\n";
if (clang_Cursor_isVariadic (cr)) {
o << " \"variadic\" : true,\n";
}
CXSourceLocation loc = clang_getCursorLocation (cr);
CXFile file; unsigned line, col, off;
clang_getFileLocation (loc, &file, &line, &col, &off);
o << " \"kind\" : \"" << kind_to_txt (cr) << "\",\n"
<< " \"src\" : \"" << clang_getCString (clang_getFileName (file)) << ":" << line << "\",\n"
<< " \"doc\" : \"" << escape_json (clang_getCString (clang_FullComment_getAsHTML (c))) << "\"\n"
<< "},\n";
dj->results[decl] = o.str ();
}
return CXChildVisit_Recurse;
}
2016-04-11 10:16:52 -04:00
static ResultMap
process_file (const char* fn, struct Dox2jsConfig *djc, bool check)
{
2016-04-11 10:16:52 -04:00
dox2js dj;
dj.cfg = djc;
if (check) {
fprintf (stderr, "--- %s ---\n", fn);
}
CXIndex index = clang_createIndex (0, check ? 1 : 0);
2016-04-11 10:16:52 -04:00
CXTranslationUnit tu = clang_createTranslationUnitFromSourceFile (index, fn, djc->clang_argc, djc->clang_argv, 0, 0);
if (tu == NULL) {
fprintf (stderr, "Cannot create translation unit for src: %s\n", fn);
2016-04-11 10:16:52 -04:00
return ResultMap ();
}
2016-04-11 10:16:52 -04:00
clang_visitChildren (clang_getTranslationUnitCursor (tu), traverse, (CXClientData) &dj);
clang_disposeTranslationUnit (tu);
clang_disposeIndex (index);
2016-04-11 10:16:52 -04:00
return dj.results;
}
static void*
process_thread (void *d)
{
struct ProcessQueue* proc = (struct ProcessQueue*) d;
pthread_mutex_lock (proc->lock);
while (1) {
if (proc->fq->empty ()) {
break;
}
char* fn = strdup (proc->fq->back ());
proc->fq->pop_back ();
pthread_mutex_unlock (proc->lock);
ResultMap rm = process_file (fn, proc->djc, proc->check_compile);
free (fn);
pthread_mutex_lock (proc->lock);
for (ResultMap::const_iterator i = rm.begin (); i != rm.end (); ++i) {
(*proc->rm)[i->first] = i->second;
}
++proc->done;
if (proc->report_progress) {
fprintf (stderr, "progress: %4.1f%% [%4d / %4d] decl: %ld \r",
100.f * proc->done / (float)proc->total, proc->done, proc->total,
proc->rm->size ());
}
}
pthread_mutex_unlock (proc->lock);
pthread_exit (NULL);
return NULL;
}
2016-04-11 10:16:52 -04:00
static void
usage (int status)
{
printf ("doxy2json - extract doxygen doc from C++ headers.\n\n");
fprintf (stderr, "Usage: dox2json [-I path]* [-X exclude]* <filename> [filename]*\n");
exit (status);
}
int main (int argc, char** argv)
{
2016-04-11 10:16:52 -04:00
struct Dox2jsConfig djc;
#define MAX_THREADS 16
pthread_t threads[MAX_THREADS];
bool report_progress = false;
bool check_compile = false;
2016-04-11 10:16:52 -04:00
size_t num_threads = 1;
int c;
2016-04-11 10:16:52 -04:00
while (EOF != (c = getopt (argc, argv, "j:D:I:TX:"))) {
switch (c) {
2016-04-11 10:16:52 -04:00
case 'j':
num_threads = std::max (1, std::min ((int)MAX_THREADS, atoi (optarg)));
break;
case 'I':
2016-04-11 10:16:52 -04:00
djc.add_clang_arg ("-I");
djc.add_clang_arg (optarg);
break;
case 'D':
2016-04-11 10:16:52 -04:00
djc.add_clang_arg ("-D");
djc.add_clang_arg (optarg);
break;
case 'X':
2016-04-11 10:16:52 -04:00
djc.add_exclude (optarg);
break;
case 'T':
check_compile = true;
break;
case 'h':
usage (0);
default:
usage (EXIT_FAILURE);
break;
}
}
if (optind >= argc) {
usage (EXIT_FAILURE);
}
const int total = (argc - optind);
if (total > 6 && !check_compile) {
report_progress = true;
}
2016-04-11 10:16:52 -04:00
ResultMap results;
std::vector<char*> src;
pthread_mutex_t lock;
pthread_mutex_init (&lock, NULL);
for (int i = optind; i < argc; ++i) {
2016-04-11 10:16:52 -04:00
src.push_back (argv[i]);
}
if (check_compile) {
num_threads = 1;
} else {
num_threads = std::min (src.size (), num_threads);
}
struct ProcessQueue proc (&src, &results, &djc, &lock, report_progress, check_compile);
for (unsigned int i = 0; i < num_threads; ++i) {
int rc = pthread_create (&threads[i], NULL, process_thread, (void *)&proc);
if (rc) {
fprintf (stderr, "failed to create thread.\n");
exit(EXIT_FAILURE);
}
}
2016-04-11 10:16:52 -04:00
pthread_yield();
for (unsigned int i = 0; i < num_threads; ++i) {
pthread_join (threads[i], NULL);
}
if (!check_compile) {
printf ("[\n");
2016-04-11 10:16:52 -04:00
for (std::map <std::string, std::string>::const_iterator i = results.begin (); i != results.end (); ++i) {
printf ("%s\n", (*i).second.c_str ());
}
printf ("{} ]\n");
}
2016-04-11 10:16:52 -04:00
pthread_mutex_destroy (&lock);
return 0;
}