## cr-parsing-location

cr-parsing-location

## Synopsis

    struct              CRParsingLocation;
    enum CRStatus       cr_parsing_location_copy            (CRParsingLocation *a_to,
                                                             CRParsingLocation const *a_from);
    void                cr_parsing_location_destroy         (CRParsingLocation *a_this);
    void                cr_parsing_location_dump            (CRParsingLocation const *a_this,
                                                             enum CRParsingLocationSerialisationMask a_mask,
                                                             FILE *a_fp);
    enum CRStatus       cr_parsing_location_init            (CRParsingLocation *a_this);
    CRParsingLocation * cr_parsing_location_new             (void);
    gchar *             cr_parsing_location_to_string       (CRParsingLocation const *a_this,
                                                             enum CRParsingLocationSerialisationMask a_mask);

## Description

## Details

### struct CRParsingLocation

    struct CRParsingLocation {
    	guint line ;
    	guint column ;
    	guint byte_offset ;
    };

### cr_parsing_location_copy ()

    enum CRStatus       cr_parsing_location_copy            (CRParsingLocation *a_to,
                                                             CRParsingLocation const *a_from);

Copies an instance of CRParsingLocation into another one.

`a_to` : | the destination of the copy. Must be allocated by the caller.
`a_from` : | the source of the copy.
Returns : | CR_OK upon succesful completion, an error code otherwise.

### cr_parsing_location_destroy ()

    void                cr_parsing_location_destroy         (CRParsingLocation *a_this);

Destroys the current instance of CRParsingLocation

`a_this` : | the current instance of CRParsingLocation. Must have been allocated with `cr_parsing_location_new()`.

### cr_parsing_location_dump ()

    void                cr_parsing_location_dump            (CRParsingLocation const *a_this,
                                                             enum CRParsingLocationSerialisationMask a_mask,
                                                             FILE *a_fp);

`a_this` : | current instance of CRParsingLocation
`a_mask` : | the serialization mask.
`a_fp` : | the file pointer to dump the parsing location to.

### cr_parsing_location_init ()

    enum CRStatus       cr_parsing_location_init            (CRParsingLocation *a_this);

Initializes the an instance of CRparsingLocation.

`a_this` : | the current instance of CRParsingLocation.
Returns : | CR_OK upon succesful completion, an error code otherwise.

### cr_parsing_location_new ()

    CRParsingLocation * cr_parsing_location_new             (void);

Returns : | the newly instanciated CRParsingLocation. Must be freed by `cr_parsing_location_destroy()`

### cr_parsing_location_to_string ()

    gchar *             cr_parsing_location_to_string       (CRParsingLocation const *a_this,
                                                             enum CRParsingLocationSerialisationMask a_mask);

`a_this` : | the current instance of CRParsingLocation.
`a_mask` : | a bitmap that defines which parts of the parsing location are to be serialized (line, column or byte offset)
Returns : | the serialized string or NULL in case of an error.