search.py 9.94 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
#!/usr/bin/python

# python script to search through doxygen_sqlite3.db
#
# Permission to use, copy, modify, and distribute this software and its
# documentation under the terms of the GNU General Public License is hereby
# granted. No representations are made about the suitability of this software
# for any purpose. It is provided "as is" without express or implied warranty.
# See the GNU General Public License for more details.
#

import sqlite3
import sys
import os
import getopt
16
import json
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

class MemberType:
  Define="0"
  Function="1"
  Variable="2"
  Typedef="3"
  Enumeration="4"
  EnumValue="5"
  Signal="6"
  Slot="7"
  Friend="8"
  DCOP="9"
  Property="10"
  Event="11"

32 33 34 35 36 37 38 39 40 41
class RequestType:
  References="9901"
  Struct="9902"
  Includers="9903"
  Includees="9904"
  Members="9905"
  BaseClasses="9906"
  SubClasses="9907"

g_conn=None
42 43 44 45 46 47
###############################################################################

def escapeLike(val):
    return 'LIKE "%' + val.replace("\\", "\\\\").replace("_", "\\_") \
        .replace("%", "\\%") + '%" ESCAPE "\\"'

48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
def matchName(name):
    if type(name) is str:
        return "name "+escapeLike(name)
    else:
        return 'id=%d' %name

def fileName(id_file):
    if g_conn.execute("SELECT COUNT(*) FROM files WHERE id=?",[id_file]).fetchone()[0] > 1:
        print "non-uniq fileid"

    for r in g_conn.execute("SELECT * FROM files WHERE id=?",[id_file]).fetchall():
            return r['name']

    return ""

def fileId(name):
    if g_conn.execute("SELECT COUNT(*) FROM files WHERE name=?",[name]).fetchone()[0] > 1:
        print "non-uniq file name"
66

67 68 69 70
    for r in g_conn.execute("SELECT * FROM files WHERE name=?",[name]).fetchall():
            return r['id']

    return -1
71 72 73

###############################################################################

74 75 76 77 78 79 80 81 82 83 84
def findReferences(name):
    o=[]

    cur = g_conn.cursor()
    cur.execute("SELECT refid FROM memberdef WHERE name=?",[name])
    refids = cur.fetchall()

    if len(refids) == 0:
        return o

    refid = refids[0]['refid']
85
    cur = g_conn.cursor()
86 87
    for info in cur.execute("SELECT * FROM xrefs WHERE dst LIKE '%"+refid+"%'"):
        item={}
88
        cur = g_conn.cursor()
89 90 91 92 93
        for i2 in cur.execute("SELECT * FROM memberdef WHERE refid=?",[info['src']]):
            item['name']=i2['name']
            item['src']=info['src']
            item['file']=fileName(info['id_file'])
            item['line']=info['line']
94

95 96
        o.append(item)
    return o
97 98


99 100 101 102 103 104 105 106 107 108 109 110
def findFunction(name):
    o=[]
    for r in g_conn.execute('SELECT * FROM memberdef WHERE '+matchName(name)+' AND kind=?',[MemberType.Function]).fetchall():
        item={}
        item['name'] = r['name']
        item['definition'] = r['definition']
        item['argsstring'] = r['argsstring']
        item['file'] = fileName(r['id_file'])
        item['line'] = r['line']
        item['detaileddescription'] = r['detaileddescription']
        o.append(item)
    return o
111

112 113 114 115 116 117

def findMacro(name):
    o=[]
    for r in g_conn.execute('SELECT * FROM memberdef WHERE '+matchName(name)+' AND kind=?',[MemberType.Define]).fetchall():
        item={}
        item['name'] = r['name']
118
        if r['argsstring']:
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
            item['argsstring'] = r['argsstring']
        item['definition'] = r['initializer']
        item['file'] = fileName(r['id_file'])
        item['line'] = r['line']
        o.append(item)
    return o


def findTypedef(name):
    o=[]
    for r in g_conn.execute('SELECT * FROM memberdef WHERE '+matchName(name)+' AND kind=?',[MemberType.Typedef]).fetchall():
        item={}
        item['name'] = r['name']
        item['definition'] = r['definition']
        item['file'] = fileName(r['id_file'])
        item['line'] = r['line']
        o.append(item)
    return o


def findVariable(name):
    o=[]
    for r in g_conn.execute('SELECT * FROM memberdef WHERE '+matchName(name)+' AND kind=?',[MemberType.Variable]).fetchall():
        item={}
        item['name'] = r['name']
        item['definition'] = r['definition']
        item['file'] = fileName(r['id_file'])
        item['line'] = r['line']
        o.append(item)
    return o

def findParams(name):
    o=[]
    for r in g_conn.execute('SELECT id FROM memberdef WHERE '+matchName(name)).fetchall():
        #a=("SELECT * FROM params where id=(SELECT id_param FROM memberdef_params where id_memberdef=?",[id_memberdef])
        item={}
        item['id'] = r['id']
        o.append(item)
    return o


def findStruct(name):
    o=[]
    for r in g_conn.execute('SELECT * FROM compounddef WHERE '+matchName(name)).fetchall():
        item={}
        item['name'] = r['name']
        o.append(item)
    return o

def findIncluders(name):
    o=[]
    fid = fileId(name)
    for r in g_conn.execute('SELECT * FROM includes WHERE id_dst=?',[fid]).fetchall():
        item={}
        item['name'] = fileName(r['id_src'])
        o.append(item)
    return o

def findIncludees(name):
    o=[]
    fid = fileId(name)
    for r in g_conn.execute('SELECT * FROM includes WHERE id_src=?',[fid]).fetchall():
        item={}
        item['name'] = r['dst']
        o.append(item)
    return o
185 186


187 188 189 190 191 192 193 194 195 196 197 198
def findMembers(name):
    o=[]
    for r in g_conn.execute('SELECT * FROM memberdef WHERE scope LIKE "%'+name+'%";').fetchall():
        item={}
        item['name'] = r['name']
        item['definition'] = r['definition']
        item['argsstring'] = r['argsstring']
        item['file'] = fileName(r['id_file'])
        item['line'] = r['line']
        item['documentation'] = r['documentation']
        o.append(item)
    return o
199 200


201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
def findBaseClasses(name):
    o=[]
    for r in g_conn.execute('SELECT base FROM basecompoundref WHERE derived=?',[name]).fetchall():
        item={}
        item['name'] = r['base']
        o.append(item)
    return o


def findSubClasses(name):
    o=[]
    for r in g_conn.execute('SELECT derived FROM basecompoundref WHERE base=?',[name]).fetchall():
        item={}
        item['name'] = r['derived']
        o.append(item)
    return o

218 219 220 221

###############################################################################

def usage():
222
  print """Usage: search.py [Options]
223 224 225
Options:
    -h, --help
    -d <D>    Use database <D> for queries
226 227 228 229 230 231 232 233 234 235
    -r <F>    Search for references to <F>
    -f <F>    Search for definition of function <F>
    -m <M>    Search for definition of macro <M>
    -t <T>    Search for definition of type <T>
    -v <V>    Search for definition of variable <V>
    -I <I>    Get the includers of <I>
    -i <I>    Get the includees of <I>
    -M <C>    Get all members of class <C>
    -B <C>    Get the base classes of class <C>
    -S <C>    Get the sub classes of class <C>
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
"""

def openDb(dbname):
    global g_conn

    if dbname == None:
        dbname = "doxygen_sqlite3.db"

    if not os.path.isfile(dbname):
        raise BaseException("No such file %s" % dbname )

    g_conn = sqlite3.connect(dbname)
    g_conn.execute('PRAGMA temp_store = MEMORY;')
    g_conn.row_factory = sqlite3.Row

###############################################################################
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
def process(kind,o):
    request_processors = {
        MemberType.Function: findFunction,
        MemberType.Define:   findMacro,
        MemberType.Variable: findVariable,
        MemberType.Typedef:  findTypedef,
        RequestType.References: findReferences,
        RequestType.Struct: findStruct,
        RequestType.Includers: findIncluders,
        RequestType.Includees: findIncludees,
        RequestType.Members: findMembers,
        RequestType.BaseClasses: findBaseClasses,
        RequestType.SubClasses: findSubClasses
    }
    return request_processors[kind](o)
267 268


269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
def processHref(ref):
    j={}

    # is it in memberdef ?
    table="memberdef"
    if ( g_conn.execute("SELECT count(*) from %s WHERE refid='%s'" % (table,ref) ).fetchone()[0] > 0 ):
        for r in g_conn.execute("SELECT kind,id FROM %s WHERE refid='%s'" % (table,ref) ).fetchall():
            j=process(str(r['kind']),int(r['id']))

    # is it in compounddef ?
    table="compounddef"
    if ( g_conn.execute("SELECT count(*) from %s WHERE refid='%s'" % (table,ref)).fetchone()[0] > 0 ):
        for r in g_conn.execute("SELECT id FROM %s WHERE refid='%s'" % (table,ref) ).fetchall():
            j=process(RequestType.Struct,int(r['id']))

    return j


def serveCgi():
    import cgi

    print 'Content-Type: application/json\n'
291

292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
    fieldStorage = cgi.FieldStorage()
    form = dict((key, fieldStorage.getvalue(key)) for key in fieldStorage.keys())

    if 'href' in form:
        ref = form['href']
    else:
        print '{"result": null, "error": "no refid given"}'
        sys.exit(0)

    openDb('doxygen_sqlite3.db')

    j = processHref(ref)

    print json.dumps({"result":j,"error":None})


def serveCli(argv):
309
    try:
310
        opts, args = getopt.getopt(argv, "hr:I:i:d:f:m:t:v:H:M:B:S:",["help"])
311 312 313 314
    except getopt.GetoptError:
        usage()
        sys.exit(1)

315
    ref=None
316
    dbname=None
317
    j={}
318 319 320 321 322 323 324

    for a, o in opts:
        if a in ('-h', '--help'):
            usage()
            sys.exit(0)
        elif a in ('-d'):
            dbname=o
325 326 327 328 329 330 331 332 333 334 335 336 337
            continue
        elif a in ('-r'):
            kind=RequestType.References
        elif a in ('-I'):
            kind=RequestType.Includers
        elif a in ('-i'):
            kind=RequestType.Includees
        elif a in ('-M'):
            kind=RequestType.Members
        elif a in ('-B'):
            kind=RequestType.BaseClasses
        elif a in ('-S'):
            kind=RequestType.SubClasses
338
        elif a in ('-f'):
339
            kind=MemberType.Function
340
        elif a in ('-m'):
341
            kind=MemberType.Define
342
        elif a in ('-t'):
343
            kind=MemberType.Typedef
344
        elif a in ('-v'):
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
            kind=MemberType.Variable
        elif a in ('-H'):
            ref = o

        openDb(dbname)
        if ref != None:
          j=processHref(ref)
        else:
          j=process(kind,o)
        print json.dumps(j)


def main(argv):
    if 'REQUEST_METHOD' in os.environ:
        serveCgi()
    else:
        serveCli(argv)
362 363 364

if __name__ == '__main__':
    main(sys.argv[1:])