Codestin Search App

Darsh-14 · 2026-02-26T13:32:20Z

Fixes #35

Adds a json=1 URL parameter to the identifier, function, and file query pages. When set, the server returns structured JSON instead of HTML. The existing HTML output path is unchanged.

Changes

Add get_display_name() overloads for IdPropElem and Call used in JSON serialisation
Add json_output parameter to display_sorted(); emits a paginated JSON object with total, page_size, skip, and results fields
xfilequery_page: JSON branch with total counted after project filtering (not raw set size)
xiquery_page: guard html_head/html_tail and section headers with !json_output
xfunquery_page: guard html_head/html_tail, section headers, and display_sorted_function_metrics with !json_output
identifier_page: JSON output for id.html?json=1 : name, unused flag, xfile flag, occurrences, attributes, projects, locations
function_page: JSON output for fun.html?json=1 : name, type, call/caller counts, declaration and definition locations, metrics
Add JSON output checkbox to iquery_page, funquery_page, and filequery_page forms

Usage

From a browser: check the JSON output checkbox on any query form.

From a script or editor plugin:

curl 'http://localhost:8081/xiquery.html?writable=1&match=Y&qi=1&json=1'

Response:

{"total": 42, "page_size": 100, "skip": 0, "results": ["foo", "bar"]}

For identifier details:

curl 'http://localhost:8081/id.html?id=0x<ptr>&json=1'

Testing

Tested on the CScout test workspace (src/makecs.cs). JSON mode returns structured output with no HTML. Default HTML behaviour is unchanged.

Darsh-14 · 2026-02-26T13:46:44Z

@dspinellis I followed the hint in the issue and added the plain text option as a checkbox next to the query title field in the identifier, function, and file query forms. Does this approach align with what you had in mind?

dspinellis

I like the approach. Please address the whitespace issue (see example in a comment), and resubmit a squashed commit.

dspinellis · 2026-02-28T16:37:39Z

-	if (!query.is_valid())
-		return 0;
+    if (!query.is_valid())
+        return 0;


For historical reasons CScout employs tabs for indentation. Please refrain from changing them into spaces.

dspinellis · 2026-02-28T22:07:20Z

Thanks! Please squash the commits into a single one.

Darsh-14 · 2026-03-01T07:37:45Z

@dspinellis Thank you for pointing that out sir. I've fixed the indentation to use tabs consistently throughout all added code and squashed everything into a single commit. Happy to contributing more to this project.

Darsh-14 · 2026-03-01T20:42:29Z

@dspinellis Since we have two different approaches for the plain text output, which one would you prefer to implement in the upcoming plugin project as well?

dspinellis

Thanks! Please see comments.

dspinellis · 2026-03-17T12:22:09Z

 	multiset <Fileid, FileQuery::specified_order> sorted_files;

-	html_head(of, "xfilequery", (qname && *qname) ? qname : "File Query Results");
+	if (!plain_text)


Consider adding the guard in html_head.

dspinellis · 2026-03-17T12:23:26Z

-	html_tail(of);
+	if (!plain_text) {
+		html_file_end(of);
+		pager.end();


Without a pager the plain text results can be excessive. Consider providing the results in JSON format together with paging information.

dspinellis · 2026-03-17T12:25:09Z

-		    "<th>Pre-cpp Value</th>"
-		    "<th>Post-cpp Value</th>"
-		    "</tr>\n");
+			"<th>Metric</th>"


I welcome these formatting fixes. Please submit them in a separate PR.

Darsh-14 · 2026-03-17T14:34:44Z

@dspinellis Thank you for the detailed feedback.

I will work on the changes in the following order:

Submit the formatting fixes as a separate PR
Move the plain_text guard inside html_head
Replace plain text output with JSON format
including paging information

I will update this PR accordingly.

…view)

Darsh-14 · 2026-03-17T20:06:52Z

@dspinellis I have addressed all the suggested review comments and implemented the changes as follows:

Moved the plain_text guard inside html_head.
html_head now accepts a bool plain_text parameter
with default false and returns early if true, removing
the need for external guards.
Replaced plain text output with JSON format including
paging information. The json=1 parameter now returns
structured JSON with total, page_size, skip, and
results fields. Page navigation uses the existing
skip parameter consistent with CScout's pager.
Submitted the formatting fixes in a separate PR Fix indentation of table headers in function and file metric pages #88 .

Happy to keep contributing and thanks for your feedback again.

dspinellis · 2026-04-05T10:52:27Z

Please also address the merge conflicts and squash the commits into a single one for the particular change.

Darsh-14 · 2026-04-05T15:03:16Z

.

Yes Sir, I'm on it. I'll get it resolved asap

…inellis#35)

Darsh-14 · 2026-04-06T20:31:31Z

Please also address the merge conflicts and squash the commits into a single one for the particular change.

@dspinellis I have resolved the merge conflicts sir and all the commits are cleanly squashed into one. Happy to make any further changes if needed.

Darsh-14 · 2026-04-19T11:21:20Z

@dspinellis Hello sir, I pushed an updated version. Addressed the paging concern by returning JSON with total, page_size, and skip fields. Also fixed a bug where total was counted before project filtering. Squashed to a single commit. Would appreciate another look when you get a chance.

Darsh-14 changed the title ~~Add plain text output option for identifier and function queries~~ Add per-query plain text output for identifier and function queries Feb 26, 2026

Darsh-14 force-pushed the master branch from 094a6ef to 453c649 Compare February 26, 2026 15:13

Darsh-14 changed the title ~~Add per-query plain text output for identifier and function queries~~ Add per-query plain text output for all queries-- identifier, file and function Feb 26, 2026

Darsh-14 changed the title ~~Add per-query plain text output for all queries-- identifier, file and function~~ Add per-query plain text output for identifier, function, and file queries Feb 26, 2026

dspinellis reviewed Feb 28, 2026

View reviewed changes

Darsh-14 force-pushed the master branch from 453c649 to 46c3eb1 Compare February 28, 2026 18:48

Darsh-14 force-pushed the master branch from 8c47149 to b609ba2 Compare March 1, 2026 07:32

dspinellis requested changes Mar 17, 2026

View reviewed changes

Darsh-14 mentioned this pull request Mar 17, 2026

Fix indentation of table headers in function and file metric pages #88

Closed

Darsh-14 force-pushed the master branch from acc56c7 to 0e8c2f1 Compare March 17, 2026 16:33

Darsh-14 added a commit to Darsh-14/cscout that referenced this pull request Mar 17, 2026

Move plain_text guard inside html_head (addresses PR dspinellis#81 re…

bd94ab8

…view)

Darsh-14 requested a review from dspinellis March 17, 2026 20:07

Darsh-14 force-pushed the master branch from b36a618 to 8bb3d18 Compare March 18, 2026 10:24

Darsh-14 force-pushed the master branch from 8bb3d18 to 4929fd3 Compare April 6, 2026 07:56

Add JSON output for identifier, function, and file queries (Fixes dsp…

a41a715

…inellis#35)

Darsh-14 force-pushed the master branch from 4929fd3 to a41a715 Compare April 6, 2026 20:24

Darsh-14 changed the title ~~Add per-query plain text output for identifier, function, and file queries~~ Add per-query JSON output for identifier, function, and file queries Apr 19, 2026

Conversation

Darsh-14 commented Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Usage

Testing

Uh oh!

Darsh-14 commented Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dspinellis left a comment

Choose a reason for hiding this comment

Uh oh!

dspinellis Feb 28, 2026

Choose a reason for hiding this comment

Uh oh!

dspinellis commented Feb 28, 2026

Uh oh!

Darsh-14 commented Mar 1, 2026

Uh oh!

Darsh-14 commented Mar 1, 2026

Uh oh!

dspinellis left a comment

Choose a reason for hiding this comment

Uh oh!

dspinellis Mar 17, 2026

Choose a reason for hiding this comment

Uh oh!

dspinellis Mar 17, 2026

Choose a reason for hiding this comment

Uh oh!

dspinellis Mar 17, 2026

Choose a reason for hiding this comment

Uh oh!

Darsh-14 commented Mar 17, 2026

Uh oh!

Darsh-14 commented Mar 17, 2026

Uh oh!

dspinellis commented Apr 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Darsh-14 commented Apr 5, 2026

Uh oh!

Darsh-14 commented Apr 6, 2026

Uh oh!

Darsh-14 commented Apr 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Darsh-14 commented Feb 26, 2026 •

edited

Loading

Darsh-14 commented Feb 26, 2026 •

edited

Loading

dspinellis commented Apr 5, 2026 •

edited

Loading