src/cityinfo.h

Go to the documentation of this file.

#ifndef __CITIES_DATABASE_H__
#define __CITIES_DATABASE_H__

#include <glib.h>

G_BEGIN_DECLS

#define CITYINFO_WRONG_ID -1

#define CITYINFO_WRONG_POS -1.0

#define CITYINFO_WRONG_LAT_LNG -181.0

typedef struct _Cityinfo Cityinfo;
struct _Cityinfo {
        /* The example is of Europe/Helsinki, whose row on the flatfile db is:
           "68|osso_db_city_helsinki|FI|osso_db_country_finland|Europe/Helsinki"
           "|0.23|0.48|fi_FI@euro" */
        gchar *name;    
        gchar *code;    
        gchar *country; 
        gchar *zone;    
        gchar *locale;  
        gdouble lat;    
        gdouble lng;    
        gdouble x;      
        gdouble y;      
        gint id;        
};


typedef gboolean (*CityinfoFunc) (const Cityinfo* city, gpointer data);

/* ==== get internal data of Cityinfo structure ==== */

gchar* cityinfo_get_name (const Cityinfo* city);

gchar* cityinfo_get_code (const Cityinfo* city);

gchar* cityinfo_get_country (const Cityinfo* city);

gchar* cityinfo_get_zone (const Cityinfo* city);

gchar* cityinfo_get_locale (const Cityinfo* city);

gdouble cityinfo_get_xpos (const Cityinfo* city);

gdouble cityinfo_get_ypos (const Cityinfo* city);

gdouble cityinfo_get_lat (const Cityinfo* city);

gdouble cityinfo_get_lng (const Cityinfo* city);

gint cityinfo_get_id (const Cityinfo* city);

/* ==== do some action on Cityinfo structure or database ==== */

Cityinfo* cityinfo_new (void);

void cityinfo_free (Cityinfo* city);

Cityinfo* cityinfo_clone (const Cityinfo* city);

void cityinfo_foreach (CityinfoFunc func, gpointer data);

Cityinfo* cityinfo_find_closest (gdouble x, gdouble y);

Cityinfo* cityinfo_from_id (gint id);

Cityinfo** cityinfo_get_all (void);

void cityinfo_free_all (Cityinfo** cities);

G_END_DECLS

#endif

---