Differential D5990 Diff 21653 query_language/grammar.js

Changeset View

Standalone View

query_language/grammar.js

This file was added.

				// Copyright (C) 2019-2021 The Software Heritage developers
				// See the AUTHORS file at the top-level directory of this distribution
				// License: GNU General Public License version 3, or any later version
				// See top-level LICENSE file for more information

				module.exports = grammar({
				name: 'swh_search_ql',

				rules: {
				query: $ => repeat(
				choice(
				$.patternFilter,
				$.booleanFilter,
				$.numericFilter,
				$.unboundedListFilter,
				$.boundedListFilter,
				$.dateFilter,
				$.limitFilter
				)
				),

				patternFilter: $ => seq($.patternField, $.patternOp, $.patternVal),
				patternField: $ => token(choice('url', 'metadata')),
				patternOp: $ => $.colonOp,
				patternVal: $ => $.string,

				booleanFilter: $ => seq($.booleanField, $.booleanOp, $.booleanVal),
				booleanField: $ => token(choice('with_visit')),
				booleanOp: $ => $.colonOp,
				booleanVal: $ => choice($.booleanTrue, $.booleanFalse),

				numericFilter: $ => seq($.numericField, $.numericOp, $.numberVal),
				numericField: $ => token(choice('nb_visits')),
				numericOp: $ => $.rangeOp,
				numberVal: $ => $.number,

				boundedListFilter: $ => choice($.visitTypeFilter, $.sortByFilter),

				visitTypeFilter: $ => seq($.visitTypeField, $.visitTypeOp, $.visitTypeVal),
				visitTypeField: $ => token(choice('visit_types')),
				visitTypeOp: $ => $.colonOp,
				visitTypeVal: $ => createArray($.visitTypeOptions),
				visitTypeOptions: $ => choice(
				"any",
				"cran",
				"deb",
				"deposit",
				"ftp",
				"hg",
				"git",
				"nixguix",
				"npm",
				"pypi",
				"svn",
				"tar"
				), // TODO: fetch this list dynamically from other swh services?

				sortByFilter: $ => seq($.sortByField, $.sortByOp, $.sortByVal),
				sortByField: $ => token(choice('sort_by')),
				sortByOp: $ => $.colonOp,
				sortByVal: $ => createArray($.sortByOptions),
				sortByOptions: $ => choice(
				'nb_visits',
				'last_visit_date',
				'last_eventful_visit_date',
				'last_revision_date',
				'last_release_date',
				'date_created',
				'date_modified',
				'date_published'
				),

				unboundedListFilter: $ => seq($.listField, $.listOp, $.listVal),
				listField: $ => token(choice('programming_languages', 'licenses', 'keywords')),
				listOp: $ => $.choiceOp,
				listVal: $ => createArray($.words), // Needs to be fixed !!
				// currently doesn't accept: licenses in ["MIT", BSD,] because of BSD (no inverted comma)
				KShivenduAuthorUnsubmitted Done Inline Actions @vlorentz I'll cover this in the next diff. KShivendu: @vlorentz I'll cover this in the next diff.


				dateFilter: $ => seq($.dateField, $.dateOp, $.dateVal),
				dateField: $ => token(choice(
				'last_visit_date',
				'last_eventful_visit_date',
				'last_revision_date',
				'last_release_date',
				'date_created',
				'date_modified',
				'date_published'
				)),
				dateOp: $ => $.rangeOp,
				dateVal: $ => $.dateWithOptionalTime,

				limitFilter: $ => seq('limit', $.colonOp, $.number),


				rangeOp: $ => token(choice('<', '<=', '=', '!=', '>=', '>')),
				colonOp: $ => token(':'),
				choiceOp: $ => token(choice('in', 'not in')),

				dateWithOptionalTime: $ => /\d{4}[-]\d{2}[-]\d{2}(\s\|T)*(\d{2}:\d{2}(:\d{2})?)?/,

				string: $ => choice(wrapWithInvertedComma($.words), $.word),
				number: $ => /\d+/,
				booleanTrue: $ => "true",
				booleanFalse: $ => "false",

				words: $ => repeat1(seq($.word)),
				word: $ => /[^\s"']+/,

				}
				});

				function commaSep1(rule) {
				return seq(rule, repeat(seq(",", optional(rule))))
				}

				function commaSep(rule) {
				return optional(commaSep1(rule))
				}

				function createArray(rule) {
				return seq('[', commaSep(
				field('array_member', (choice(wrapWithInvertedComma(rule), rule)))
				), ']')
				}

				function wrapWithInvertedComma(rule) {
				return choice(
				seq("'", rule, "'"),
				seq('"', rule, '"')
				)
				}