Skip to content

v.profile: Add JSON output format #6875

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
saket0187 wants to merge 9 commits into
base: main
Choose a base branch
from
+350 −69
Open

v.profile: Add JSON output format #6875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
8f20bc1
v.profile: Added JSON output format support
saket0187 Jan 5, 2026
a8597a0
v.profile: Added testJsonFormat() for JSON validation
saket0187 Jan 5, 2026
122874b
v.profile: Updated documentation for new output formats
saket0187 Jan 5, 2026
d27a5c1
v.profile: Added CSV and JSON output formats
saket0187 Jan 7, 2026
48c2738
Added tests for JSON format output
saket0187 Jan 7, 2026
ec956be
Update documentation for output formats
saket0187 Jan 7, 2026
81b1118
JSON support
saket0187 Jan 14, 2026
d06bd83
Add output formats
saket0187 Jan 18, 2026
f16a9a4
Update vector/v.profile/main.c
saket0187 Jan 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions vector/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,6 +391,7 @@ build_program_in_subdir(
grass_dbmiclient
grass_gis
grass_vector
grass_parson
OPTIONAL_DEPENDS
GEOS::geos_c)

Expand Down
2 changes: 1 addition & 1 deletion vector/v.profile/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ MODULE_TOPDIR = ../..

PGM = v.profile

LIBES = $(VECTORLIB) $(DBMILIB) $(GISLIB) $(GEOSLIBS)
LIBES = $(VECTORLIB) $(DBMILIB) $(GISLIB) $(GEOSLIBS) $(PARSONLIB)
DEPENDENCIES = $(VECTORDEP) $(DBMIDEP) $(GISDEP)
EXTRA_INC = $(VECT_INC)
EXTRA_CFLAGS = $(VECT_CFLAGS) $(GEOSCFLAGS)
Expand Down
275 changes: 208 additions & 67 deletions vector/v.profile/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
#include <grass/vector.h>
#include <grass/dbmi.h>
#include <grass/glocale.h>

#include <grass/gjson.h>
#include "local_proto.h"

#if HAVE_GEOS
Expand All @@ -47,6 +47,8 @@
* or so as there's nothing more permanent than a temporary solution.)
* 2017-11-19
*/
enum OutputFormat { PLAIN, CSV, JSON };

static int ring2pts(const GEOSGeometry *geom, struct line_pnts *Points)
{
int i, ncoords;
Expand Down Expand Up @@ -136,7 +138,7 @@ int main(int argc, char *argv[])
struct GModule *module;
struct Option *old_map, *new_map, *coords_opt, *buffer_opt, *delim_opt,
*dp_opt, *layer_opt, *where_opt, *inline_map, *inline_where,
*inline_layer, *type_opt, *file_opt;
*inline_layer, *type_opt, *file_opt, *format_opt;
struct Flag *no_column_flag, *no_z_flag;

struct field_info *Fi, *Fpro;
Expand All @@ -147,6 +149,11 @@ int main(int argc, char *argv[])
dbColumn *column;
dbString table_name, dbsql, valstr;

enum OutputFormat format;
G_JSON_Value *root_value = NULL, *item_value = NULL;
G_JSON_Array *root_array = NULL;
G_JSON_Object *item_object = NULL;

/* initialize GIS environment */
G_gisinit(argv[0]);

Expand Down Expand Up @@ -197,6 +204,15 @@ int main(int argc, char *argv[])
dp_opt->description = _("Number of significant digits");
dp_opt->guisection = _("Format");

format_opt = G_define_standard_option(G_OPT_F_FORMAT);
format_opt->options = "plain,csv,json";
format_opt->required = NO;
format_opt->answer = "plain";
format_opt->descriptions = _("plain;Plain text with pipe separator;"
"csv;CSV (Comma Separated Values);"
"json;JSON (JavaScript Object Notation)");
format_opt->guisection = _("Format");

/* Profiling tolerance */
buffer_opt = G_define_option();
buffer_opt->key = "buffer";
Expand Down Expand Up @@ -272,6 +288,20 @@ int main(int argc, char *argv[])

if (G_parser(argc, argv))
exit(EXIT_FAILURE);
if (strcmp(format_opt->answer, "json") == 0) {
format = JSON;
root_value = G_json_value_init_array();
if (root_value == NULL) {
G_fatal_error(_("Failed to initialize JSON array. Out of memory?"));
}
root_array = G_json_array(root_value);
}
else if (strcmp(format_opt->answer, "csv") == 0) {
format = CSV;
}
else {
format = PLAIN;
}

#if HAVE_GEOS
#if (GEOS_VERSION_MAJOR < 3 || \
Expand Down Expand Up @@ -388,6 +418,10 @@ int main(int argc, char *argv[])
open3d = WITHOUT_Z;

/* the field separator */
if (delim_opt->count == 0 && format == CSV) {
delim_opt->answer = "comma";
}

fs = G_option_to_separator(delim_opt);

/* Let's get vector layers db connections information */
Expand Down Expand Up @@ -677,84 +711,191 @@ int main(int argc, char *argv[])
/* Sort results by distance, cat */
qsort(&resultset[0], rescount, sizeof(Result), compdist);

/* Print out column names */
if (!no_column_flag->answer) {
fprintf(ascii, "Number%sDistance", fs);
if (open3d == WITH_Z)
fprintf(ascii, "%sZ", fs);
if (Fi != NULL) {
/* ncols are initialized here from previous Fi != NULL if block */
for (col = 0; col < ncols; col++) {
column = db_get_table_column(table, col);
fprintf(ascii, "%s%s", fs, db_get_column_name(column));
/* Print output based on format */
switch (format) {
case PLAIN: /* Use same code as CSV */
case CSV:
/* Print out column names */
if (!no_column_flag->answer) {
fprintf(ascii, "Number%sDistance", fs);
if (open3d == WITH_Z)
fprintf(ascii, "%sZ", fs);
if (Fi != NULL) {
/* ncols are initialized here from previous Fi != NULL if block
*/
for (col = 0; col < ncols; col++) {
column = db_get_table_column(table, col);
fprintf(ascii, "%s%s", fs, db_get_column_name(column));
}
}
fprintf(ascii, "\n");
}
fprintf(ascii, "\n");
}

/* Print out result */
for (j = 0; j < rescount; j++) {
fprintf(ascii, "%zu%s%.*f", j + 1, fs, dp, resultset[j].distance);
if (open3d == WITH_Z)
fprintf(ascii, "%s%.*f", fs, dp, resultset[j].z);
if (Fi != NULL) {
snprintf(sql, sizeof(sql), "select * from %s where %s=%d",
Fi->table, Fi->key, resultset[j].cat);
G_debug(2, "SQL: \"%s\"", sql);
db_set_string(&dbsql, sql);
/* driver IS initialized here in case if Fi != NULL */
if (db_open_select_cursor(driver, &dbsql, &cursor, DB_SEQUENTIAL) !=
DB_OK)
G_warning(_("Unable to get attribute data for cat %d"),
resultset[j].cat);
else {
nrows = db_get_num_rows(&cursor);
G_debug(1, "Result count: %d", nrows);
table = db_get_cursor_table(&cursor);

if (nrows > 0) {
if (db_fetch(&cursor, DB_NEXT, &more) != DB_OK) {
G_warning(_("Error while retrieving database record "
"for cat %d"),
resultset[j].cat);
}
else {
for (col = 0; col < ncols; col++) {
/* Column description retrieving is fast, as they
* live in provided table structure */
column = db_get_table_column(table, col);
db_convert_column_value_to_string(column, &valstr);
type = db_get_column_sqltype(column);

/* Those values should be quoted */
if (type == DB_SQL_TYPE_CHARACTER ||
type == DB_SQL_TYPE_DATE ||
type == DB_SQL_TYPE_TIME ||
type == DB_SQL_TYPE_TIMESTAMP ||
type == DB_SQL_TYPE_INTERVAL ||
type == DB_SQL_TYPE_TEXT ||
type == DB_SQL_TYPE_SERIAL)
fprintf(ascii, "%s\"%s\"", fs,
db_get_string(&valstr));
else
fprintf(ascii, "%s%s", fs,
db_get_string(&valstr));
/* Print out result */
for (j = 0; j < rescount; j++) {
fprintf(ascii, "%zu%s%.*f", j + 1, fs, dp, resultset[j].distance);
if (open3d == WITH_Z)
fprintf(ascii, "%s%.*f", fs, dp, resultset[j].z);

if (Fi != NULL) {
snprintf(sql, sizeof(sql), "select * from %s where %s=%d",
Fi->table, Fi->key, resultset[j].cat);
G_debug(2, "SQL: \"%s\"", sql);
db_set_string(&dbsql, sql);
/* driver IS initialized here in case if Fi != NULL */
if (db_open_select_cursor(driver, &dbsql, &cursor,
DB_SEQUENTIAL) != DB_OK) {
G_warning(_("Unable to get attribute data for cat %d"),
resultset[j].cat);
fprintf(ascii, "\n");
}
else {
nrows = db_get_num_rows(&cursor);
table = db_get_cursor_table(&cursor);

if (nrows > 0) {
if (db_fetch(&cursor, DB_NEXT, &more) != DB_OK) {
G_warning(_("Error while retrieving database "
"record for cat %d"),
resultset[j].cat);
}
else {
for (col = 0; col < ncols; col++) {
/* Column description retrieving is fast, as
* they live in provided table structure */
column = db_get_table_column(table, col);
db_convert_column_value_to_string(column,
&valstr);
type = db_get_column_sqltype(column);

/* Those values should be quoted */
if (type == DB_SQL_TYPE_CHARACTER ||
type == DB_SQL_TYPE_DATE ||
type == DB_SQL_TYPE_TIME ||
type == DB_SQL_TYPE_TIMESTAMP ||
type == DB_SQL_TYPE_INTERVAL ||
type == DB_SQL_TYPE_TEXT ||
type == DB_SQL_TYPE_SERIAL)
fprintf(ascii, "%s\"%s\"", fs,
db_get_string(&valstr));
else
fprintf(ascii, "%s%s", fs,
db_get_string(&valstr));
}
}
db_close_cursor(&cursor);
}
}
}
fprintf(ascii, "\n");
/* Terminate attribute data line and flush data to provided output
* (file/stdout) */
if (fflush(ascii))
G_fatal_error(
_("Can not write data portion to provided output"));
}
break;

case JSON:
/* Build JSON array */
for (j = 0; j < rescount; j++) {
item_value = G_json_value_init_object();
if (item_value == NULL) {
G_fatal_error(
_("Failed to initialize JSON object. Out of memory?"));
}
item_object = G_json_object(item_value);

/* Always include category and distance */
G_json_object_set_number(item_object, "category", resultset[j].cat);
G_json_object_set_number(item_object, "distance",
resultset[j].distance);

if (open3d == WITH_Z)
G_json_object_set_number(item_object, "z", resultset[j].z);

/* Add attributes */
if (Fi != NULL) {
snprintf(sql, sizeof(sql), "select * from %s where %s=%d",
Fi->table, Fi->key, resultset[j].cat);
G_debug(2, "SQL: \"%s\"", sql);
db_set_string(&dbsql, sql);

if (db_open_select_cursor(driver, &dbsql, &cursor,
DB_SEQUENTIAL) != DB_OK) {
G_warning(_("Unable to get attribute data for cat %d"),
resultset[j].cat);
}
else {
for (col = 0; col < ncols; col++) {
fprintf(ascii, "%s", fs);
nrows = db_get_num_rows(&cursor);
table = db_get_cursor_table(&cursor);

if (nrows > 0) {
if (db_fetch(&cursor, DB_NEXT, &more) != DB_OK) {
G_warning(_("Error while retrieving database "
"record for cat %d"),
resultset[j].cat);
}
else {
G_JSON_Value *attr_value =
G_json_value_init_object();
G_JSON_Object *attr_object =
G_json_object(attr_value);

for (col = 0; col < ncols; col++) {
column = db_get_table_column(table, col);
dbValue *value = db_get_column_value(column);
int ctype = db_get_column_sqltype(column);
const char *col_name =
db_get_column_name(column);

if (db_test_value_isnull(value)) {
G_json_object_set_null(attr_object,
col_name);
}
else if (ctype == DB_SQL_TYPE_INTEGER) {
G_json_object_set_number(
attr_object, col_name,
db_get_value_int(value));
}
else if (ctype == DB_SQL_TYPE_REAL) {
G_json_object_set_number(
attr_object, col_name,
db_get_value_double(value));
}
else {
db_convert_column_value_to_string(column,
&valstr);
G_json_object_set_string(
attr_object, col_name,
db_get_string(&valstr));
}
}

G_json_object_set_value(item_object, "attributes",
attr_value);
}
db_close_cursor(&cursor);
}
}
}
db_close_cursor(&cursor);
G_json_array_append_value(root_array, item_value);
}
/* Terminate attribute data line and flush data to provided output
* (file/stdout) */
fprintf(ascii, "\n");
/* Output JSON */
char *json_string = G_json_serialize_to_string_pretty(root_value);
if (!json_string) {
G_json_value_free(root_value);
G_fatal_error(_("Failed to serialize JSON to pretty format."));
}

fputs(json_string, ascii);
fputc('\n', ascii);
/* Flush data to provided output (file/stdout) */
if (fflush(ascii))
G_fatal_error(_("Can not write data portion to provided output"));
G_json_free_serialized_string(json_string);
G_json_value_free(root_value);
break;
}

/* Build topology for vector map and close them */
Expand Down
Loading
Loading