plugins/symbol-db/symbol-db-engine-utils.h

   1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
   2 /*
   3  * anjuta
   4  * Copyright (C) Massimo Cora' 2007-2008 <maxcvs@email.it>
   5  *
   6  * anjuta is free software.
   7  *
   8  * You may redistribute it and/or modify it under the terms of the
   9  * GNU General Public License, as published by the Free Software
  10  * Foundation; either version 2 of the License, or (at your option)
  11  * any later version.
  12  *
  13  * anjuta is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  16  * See the GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with anjuta.  If not, write to:
  20  *      The Free Software Foundation, Inc.,
  21  *      51 Franklin Street, Fifth Floor
  22  *      Boston, MA  02110-1301, USA.
  23  */
  24
  25 #ifndef _SYMBOL_DB_ENGINE_UTILS_H_
  26 #define _SYMBOL_DB_ENGINE_UTILS_H_
  27
  28 #include <glib-object.h>
  29 #include <glib.h>
  30
  31 #include "symbol-db-engine-priv.h"
  32 #include "symbol-db-engine.h"
  33
  34
  35 /**
  36  * Simple compare function for GTree(s)
  37  */
  38 gint
  39 symbol_db_gtree_compare_func (gconstpointer a, gconstpointer b, gpointer user_data);
  40
  41 /**
  42  * Simple compare function for GList(s)
  43  */
  44 gint
  45 symbol_db_glist_compare_func (gconstpointer a, gconstpointer b);
  46
  47 /**
  48  * @return full_local_path given a relative-to-db file path.
  49  * User must care to free the returned string.
  50  * @param db_file Relative path inside project.
  51  */
  52 gchar *
  53 symbol_db_util_get_full_local_path (SymbolDBEngine *dbe, const gchar* db_file);
  54
  55 /**
  56  * @return a db-relativ file path. Es. given the full_local_file_path
  57  * /home/user/foo_project/src/foo.c returned file should be /src/foo.c.
  58  * Return NULL on error.
  59  * Please note that the returned const gchar is related to full_local_file_path:
  60  * don't free full_local_file_path before having used the returned char, otherwise
  61  * they both will become invalid.
  62  */
  63 const gchar *
  64 symbol_db_util_get_file_db_path (SymbolDBEngine *dbe, const gchar* full_local_file_path);
  65
  66 /**
  67  * Try to get all the files with zero symbols: these should be the ones
  68  * excluded by an abort on population process.
  69  * @return A GPtrArray with paths on disk of the files. Must be unreffed by caller using
  70  * g_ptr_array_unref (). Being created with g_ptr_array_new_with_free_func (g_free) there's
  71  * no need to free its items.
  72  * @return NULL if no files are found.
  73  */
  74 GPtrArray *
  75 symbol_db_util_get_files_with_zero_symbols (SymbolDBEngine *dbe);
  76
  77 /**
  78  * @return The pixbufs. It will initialize pixbufs first if they weren't before
  79  * @param node_access can be NULL.
  80  */
  81 const GdkPixbuf *
  82 symbol_db_util_get_pixbuf  (const gchar *node_type, const gchar *node_access);
  83
  84 #endif