Analysis Search Language

• Grammar
• Examples
• SQL Terms

Grammar

The analysis search language grammar is based on the standard CodeSonar search grammar, with several extensions:

• In addition to the term (T) forms provided in the standard search grammar, there are four new forms: metric-condition, property-condition, ilike-condition, and imatch-condition.
• There are domain-specific field-name values.
• none (case insensitive) is not treated as an ordinary word. Instead, it matches all of the following.
  • literal string none (case insensitive)
  • fields whose value is the empty string
  • empty fields (that is, fields that don't contain any value at all, not even a default value)
  Plain text search in the analysis search language covers several fields, including some that many users choose to leave empty, such as Analysis Description (adesc). Consequently, performing a plain text search for none (or "none", which CodeSonar will normalize to none) may match analyses that do not contain literal string none.To avoid this issue, use one or more field-condition, ilike-condition, or imatch-condition terms to restrict the search to the precise field or fields you are interested in.

Literal strings are displayed in pink text.

T : quoted-string
  | metric-condition
  | property-condition
  | ilike-condition
  | imatch-condition
  | state-condition
  | field-condition
  | ( T )
  | unary T
  | T binary T
  | T T
  | word
  | none
  
metric-condition : metric-tag ext-operator num
                 | metric-tag operator num-range

metric-tag : the tag of any analysis-granularity metric class (built-in or user-defined) on the hub 

property-condition : property-key operator word
                   | property-key operator quoted-string

property-key : the key of any user-assigned analysis property associated with at least one analysis on the hub 

state-condition : state ext-operator analysis-state
                | state operator analysis-state-range 
                (see note below)

ext-operator : <
             | <=
             | >=
             | >

field-name : adesc
           | address 
           | aid 
           | analysis 
           | dryrun 
           | filecount 
           | finished 
           | install 
           | machine 
           | mostrecent 
           | prjfiles 
           | protected 
           | pdesc 
           | pid 
           | project 
           | ptree_path 
           | started 
           | sql 
           | user 
           | warningcount 

analysis-state-range : analysis-state?..analysis-state
                     | analysis-state..analysis-state?
                     | analysis-state

analysis-state : "Unexpected State"
               | "Initialized"
               | "Building"
               | "Building over; "
               | "Stalled"
               | "Stalled"
               | "Linking"
               | "Removing Obsolete Translation Units"
               | "Parsing Translation Units"
               | "Getting Models"
               | "Comparing Compilations"
               | "Resolving Names"
               | "Indexing Source Files"
               | "Updating Old Variables"
               | "Computing Call Graph"
               | "Updating Variable Maps"
               | "Building Procedures"
               | "Updating Variables"
               | "Updating Variable Maps"
               | "Building Undefined Procedures"
               | "Updating Program Points"
               | "Compacting Program Points"
               | "Demangling Names"
               | "Updating Callers"
               | "Finalizing Linkage"
               | "Dropping Compilations"
               | "Indexing Cross References"
               | "Acquiring License Key"
               | "Pruning Summaries"
               | "Garbage Collecting"
               | "Enumerating Languages"
               | "Adjusting Call Graph"
               | "Building Procedure List"
               | "Removing Old Source Files"
               | "Computing Reachable Procedures"
               | "Analyzing Translation Units Serially"
               | "Topologically Sorting Procedures"
               | "Analyzing Translation Units"
               | "Analyzing Pointers"
               | "Computing Visualization Data"
               | "Analyzing"
               | "Refining Warnings"
               | "Finished"
               | "Finished"
      

field-condition terms

The following table shows the relationship between the analysis-specific field-name values and the properties of an analysis, along with the expected type of the condition part of a field-condition.

Although state and metric-tag, and property-key are not field-name values, we include them in this table for completeness.

state-condition terms

All analysis-state values are matched exactly (but case-insensitively). One consequence is that state:X and state=X are always synonymous.

Quote marks can be omitted if the value contains no whitespace or punctuation.

All analysis-state-range sets and ext-operator results are computed with respect to the ordering shown for analysis-state. There are several cases in which different states have the same analysis-state value: state-condition terms that include any of these values are interpreted so as to minimize the matched set of states.

Plain text terms: word, quoted-string, and none

Plain text search terms—word, quoted-string, and none—are compared against a subset of the fields, with substring search:

• str is equivalent to
  analysis:str | prjfiles:str | user:str | machine:str | install:str | address:str | adesc:str | state:str

Examples

SQL Terms

The sql field-name is provided to allow extra search customization, but is not supported. It is only available to users with G_SQL_CONSOLE permission.

For a search that includes a field-condition of the form

CodeSonar will obtain search results by executing an SQL statement of the form

SELECT <your specified columns>
   FROM <CodeSonar-determined relation>
   WHERE <other-terms1 OP1> cond  <OP2 other-terms2>
   ORDER BY <your specified order>
  

where

• In cases where the FROM clause does not include attributes that you want to test in the WHERE clause, you will need to include a suitable EXISTS statement in cond. For example, to find analyses that issued one or more warnings assigned to user alex:
  sql:"EXISTS (SELECT * FROM cs_user,cs_warningreport, cs_warninginstance WHERE cs_user.name_xml LIKE 'alex' AND cs_user.id=cs_warningreport.owner_id AND cs_warningreport.id=cs_warninginstance.report_id AND cs_warninginstance.analysis_id=cs_analysis.id)"
• To see samples of CodeSonar's SQL queries in general and WHERE clauses in particular, use your web browser to view the source of any analysis search results page. The SQL query used to obtain the results shown on the page is included in an HTML comment directly above the result table.
• The hub database schema is available for inspection at $CSONAR/codesonar/py/SCHEMA.
  You can also use the SQL Console to examine the schema programmatically.