~ubuntu-branches/ubuntu/raring/geany/raring-proposed

« back to all changes in this revision

Viewing changes to tagmanager/include/tm_workspace.h

  • Committer: Bazaar Package Importer
  • Author(s): Damián Viano
  • Date: 2008-05-02 11:37:45 UTC
  • mto: (3.1.1 lenny) (1.3.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 12.
  • Revision ID: james.westby@ubuntu.com-20080502113745-7q62rqhl2ku02ptu
Import upstream version 0.14

Show diffs side-by-side

added added

removed removed

Lines of Context:
79
79
/*! Removes a member object from the workspace if it exists.
80
80
 \param work_object Pointer to the work object to be removed.
81
81
 \param free Whether the work object is to be freed as well.
 
82
 \param update Whether to update workspace objects.
82
83
 \return TRUE on success, FALSE on failure (e.g. the work object does not exist).
83
84
*/
84
 
gboolean tm_workspace_remove_object(TMWorkObject *work_object, gboolean free);
 
85
gboolean tm_workspace_remove_object(TMWorkObject *work_object, gboolean free, gboolean update);
85
86
 
86
87
/*! Loads the global tag list from the specified file. The global tag list should
87
88
 have been first created using tm_workspace_create_global_tags().
90
91
 \sa tm_workspace_create_global_tags()
91
92
*/
92
93
gboolean tm_workspace_load_global_tags(const char *tags_file, gint mode);
93
 
//gboolean tm_workspace_load_global_tags(const char *tags_file);
 
94
/*gboolean tm_workspace_load_global_tags(const char *tags_file);*/
94
95
 
95
96
/*! Creates a list of global tags. Ideally, this should be created once during
96
97
 installations so that all users can use the same file. Thsi is because a full
100
101
 \param includes Include files to process. Wildcards such as '/usr/include/a*.h'
101
102
 are allowed.
102
103
 \param tags_file The file where the tags will be stored.
 
104
 \param lang The language to use for the tags file.
103
105
 \return TRUE on success, FALSE on failure.
104
106
*/
105
 
gboolean tm_workspace_create_global_tags(const char *pre_process, const char **includes
106
 
  , int includes_count, const char *tags_file);
 
107
gboolean tm_workspace_create_global_tags(const char *config_dir, const char *pre_process,
 
108
        const char **includes, int includes_count, const char *tags_file, int lang);
107
109
 
108
110
/*! Recreates the tag array of the workspace by collecting the tags of
109
111
 all member work objects. You shouldn't have to call this directly since
138
140
const GPtrArray *tm_workspace_find(const char *name, int type, TMTagAttrType *attrs
139
141
 , gboolean partial, langType lang);
140
142
 
 
143
/*! Returns all matching tags found in the workspace.
 
144
 \param name The name of the tag to find.
 
145
 \param scope The scope name of the tag to find, or NULL.
 
146
 \param type The tag types to return (TMTagType). Can be a bitmask.
 
147
 \param attrs The attributes to sort and dedup on (0 terminated integer array).
 
148
 \param partial Whether partial match is allowed.
 
149
 \param lang Specifies the language(see the table in parsers.h) of the tags to be found,
 
150
             -1 for all
 
151
 \return Array of matching tags. Do not free() it since it is a static member.
 
152
*/
 
153
const GPtrArray *
 
154
tm_workspace_find_scoped (const char *name, const char *scope, gint type,
 
155
                TMTagAttrType *attrs, gboolean partial, langType lang, gboolean global_search);
 
156
 
 
157
/*! Returns TMTag to function which "own" given line
 
158
 \param line Current line in edited file.
 
159
 \param file_tags A GPtrArray of edited file TMTag pointers.
 
160
 \return TMTag pointers to owner function. */
 
161
const TMTag *tm_get_current_function(GPtrArray *file_tags, const gulong line);
 
162
 
141
163
/*! Returns a list of parent classes for the given class name
142
164
 \param name Name of the class
143
165
 \return A GPtrArray of TMTag pointers (includes the TMTag for the class) */