tm_work_object.h File Reference

A TMWorkObject structure is the base class for TMSourceFile and TMProject. More...

Data Structures
struct	TMWorkObject
Typedefs
typedef struct TMWorkObject	TMWorkObject
Functions
gchar *	tm_get_real_path (const gchar *file_name)
void	tm_work_object_free (gpointer work_object)

---

Detailed Description

A TMWorkObject structure is the base class for TMSourceFile and TMProject.

---

Typedef Documentation

typedef struct TMWorkObject TMWorkObject

A TMWorkObject structure is the base class for TMSourceFile and TMProject. This struct contains data common to all work objects, namely, a file name, time when the file was analyzed (for caching) and an array of tags which should be populated when the object is analyzed.

---

Function Documentation

gchar* tm_get_real_path

(

const gchar *

file_name

)

Given a file name, returns a newly allocated string containing the realpath() of the file.

Parameters:

file_name

The original file_name

Returns:

A newly allocated string containing the real path to the file. NULL if none is available.

void tm_work_object_free

(

gpointer

work_object

)

Deallocates a work object and it's component structures. The user can call this function directly since it will automatically call the correct deallocator function of the derived class if required.

Parameters:

work_object

Pointer to a work object or an object derived from it.