SAST Query Language APIs

Adds to the current instance the given graph node, indexed by the given id.

Expand source

public void Add(int a, IGraph b)

This example demonstrates the CxList.Add(int, IGraph) method.

The input source code is:

Expand source

int b, a = 5;
if (a == 33)
b = 6;

The source code that uses CxList.Add method:

Expand source

CxList myList = All.FindByName(“a”);
CSharpGraph nodeGraph = All.FindByName(“b”).GetFirstGraph();
myList.Add(nodeGraph.NodeId, nodeGraph);
result = myList;

The resulting list will include the initial two “a”’s and the first b.

Add all the elements from the given CxList to the current instance.

Expand source

public void Add(CxList a)

This example demonstrates the CxList.Add(CxList) method.

The input source code is:

Expand source

int b, a = 5;
if (a == 33)
b = 6;

The source code that uses CxList.Add method:

Expand source

CxList list_a = All.FindByName(“a”);
CxList list_b = All.FindByName(“b”);
list_a.Add(list_b);
result = list_a;

The resulting list will contain 4 elements.

Adds to the current instance all the elements from the given CxLists.

Expand source

public void Add(IEnumerable<CxList> a)

This example demonstrates the CxList.Add(IEnumerable<CxList>) method.

The input source code is:

Expand source

int b, a = 5;
if (a == 33)
b = 6;

The source code that uses CxList.Add method:

Expand source

CxList a = All.FindByName(“a”);
CxList b = All.FindByName(“b”);
CxList integers = All.FindByType(typeof(IntegerLiteral));
Result.AddRange(new List<CxList>(){a, b, integers});

The resulting list will include the two “a”’s, two “b”’s and the numbers 5, 33, 6.

Adds to the current instance all the elements from the given CxLists.

Expand source

public void Add(params CxList[] lists)

This example demonstrates the CxList.Add(params CxList[]) method.

The input source code is:

Expand source

int b, a = 5;
if (a == 33)
b = 6;

The source code that uses CxList.Add method:

Expand source

CxList a = All.FindByName(“a”);
CxList b = All.FindByName(“b”);
CxList integers = All.FindByType(typeof(IntegerLiteral));
Result.Add(a, b, integers);

The resulting list will include the two "a"'s, two "b"'s and the numbers 5, 33, 6.

Supported from 9.1.0

Add the given pair to the current CxList instance.

Expand source

public void Add((KeyValuePair<int, IGraph> dic)

This example demonstrates the CxList.Add(KeyValuePair<int, IGraph>) method.

The input source code is:

Expand source

int b, a = 5;
if (a == 33)
b = 6;

The source code that uses CxList.Add method:

Expand source

CxList myList = All.FindByName(“a”);
foreach(KeyValuePair<int, IGraph> entry in All.FindByName(“b”))
{
    myList.Add(entry);
}
result = myList;

The resulting list will contain 4 elements.

Adds to the current instance all the elements from the given CxLists.

Expand source

public void AddRange(IEnumerable<CxList> lists)

This example demonstrates the CxList.AddRange(IEnumerable<CxList>) method.

The input source code is:

Expand source

int b, a = 5;
if (a == 33)
b = 6;

The source code that uses CxList.AddRange method:

Expand source

CxList a = All.FindByName("a");
CxList b = All.FindByName("b");
CxList integers = All.FindByType(typeof(IntegerLiteral));
Result.AddRange(new List<CxList>(){a, b, integers});

The resulting list will include the two "a"'s, two "b"'s and the numbers 5, 33, 6.

Supported from 9.1.0

add the support of a framework expression language

Gets the elements with the specified System.Xml.Linq.XName.

A System.Xml.Linq.XElement that matches the specified System.Xml.Linq.XName, or null.

function to calculate pragma unique id

None

Returns a CxList which is a subset of “this” instance and are methods or constructors declarations which matches the given CxList elements.

Expand source

public CxList CallingMethodOfAny(CxList list)

This example demonstrates the CxList.CallingMethodOfAny(CxList) method.

The input source code is:

Expand source

void foo()
{
    int goo = 3;
    int boo = 5;
}

The source code that uses CxList.CallingMethodOfAny method:

Expand source

result = All.CallingMethodOfAny(All.FindByName ("oo"));

The result would consist of 1 item:

Expand source

foo (in void foo())

Clears the information in “this” instance.

Expand source

public bool Clear()

This method removes all the information stored in the List.

This example demonstrates the CxList.Clear() method.

Expand source

CxList MyList = All ;
MessageBox.Show(MyList.Count.ToString());
MyList.Clear();
MessageBox.Show(MyList.Count.ToString());

Clears all the data allocated in the _GraphToNodeAdditional and _NodeToGraphAdditional data members for the current thread.

remove all flow

Call this method at the finally clause of every query.

create duplicate of this

None

Clone the current (this) CxList

Expand source

public CxList Clone ()

CxList containing a clone of the current (this) CxList

The source code that uses CxList.Clone method:

Expand source

CxList A = All.FindByType(typeof(UnknownReference));
CxList B = A; //B points to same elements as A
CxList B = A.Clone(); //B has a copy (clone) of the elements in A

Concatenates two nodes into a flow.

Expand source

public CxList Concatenate (CxList list)

A flow that starts with this instance node, and ends with the list parameter node.

Supported from v7.1.2

Concatenates two nodes into a flow.

Expand source

public CxList Concatenate (CxList list, bool _testFlow)

A flow that starts with this instance node, and ends with the list parameter node.

This example demonstrates the Concatenate(CxList, bool) method.

The input source code is:

Expand source

void main()
{
    int a = 1;
    int b = 2;
    int c = a + b;
    printf("%d", c);
}

The source code that uses CxList.Concatenate method:

Expand source

CxList one = All.FindByName("1");
CxList two = All.FindByName("2");
result = one.Concatenate(two, false);

The result would be:

Expand source

1 flow found:
[1] -> [2]

Supported from 7.1.2

Concatenates all flows in this instance to all flows in list.

Expand source

public CxList ConcatenateAllPaths (CxList secondList, bool _testFlow)

A product of all flows in this instance with the ones in list parameter.

If this instance contains n flows in it and list contains m flows in it, the return set will contain nxm flows, where each flow from this instance will be concatenated to each flow from list.

This example demonstrates the ConcatenateAllPaths(CxList, bool) method.

The input source code is:

Expand source

void main()
{
    int a = 1;
    int b = 2;
}

The source code that uses CxList.ConcatenateAllPaths method:

Expand source

CxList one = All.FindByName("1");
CxList a = All.FindByShortName("a").FindByType(typeof(Declarator));
CxList flow1 = a.InfluencedBy(one); // [1] -> [a]
CxList two = All.FindByName("2");
CxList b = All.FindByShortName("b").FindByType(typeof(Declarator));
CxList flow2 = b.InfluencedBy(two); // [2] -> [b]
CxList flow = flow1 + flow2;
result = flow.ConcatenateAllPaths(flow, false);

The result would be:

Expand source

4 flow found:
[1] -> [a] -> [1] -> [a]
[1] -> [a] -> [2] -> [b]
[2] -> [b] -> [1] -> [a]
[2] -> [b] -> [2] -> [b]

Supported from 7.1.2

Concatenates all flows in this instance to all flows in list.

Expand source

public CxList ConcatenateAllPaths (CxList secondList)

A product of all flows in this instance with the ones in list parameter.

Supported from 7.1.2

Concatenates the node in list to each node in this instance. Concatenation is node-to-node (doesn't support connecting flows).

Expand source

public CxList ConcatenateAllSources (CxList list, bool _testFlow)

Flows that starts with this instance nodes, and end with the list parameter node.

This example demonstrates the ConcatenateAllSources(CxList, bool) method.

The input source code is:

Expand source

void main()
{
    int a = 1;
    int b = 2;
}

The source code that uses CxList.ConcatenateAllSources method:

Expand source

CxList a = All.FindByShortName("a").FindByType(typeof(Declarator));
CxList b = All.FindByShortName("b").FindByType(typeof(Declarator));
CxList main = All.FindByShortName("main");
CxList list = a + b;
result = list.ConcatenateAllSources(list, false);

The result would be:

Expand source

2 flow found:
[a] -> [main]
[b] -> [main]

Supported from 7.1.2

Concatenates the node in list to each node in this instance. Concatenation is node-to-node (doesn't support connecting flows).

Note: Currently is identical to calling ConcatenateAllSources with testFlow = false

Expand source

public CxList ConcatenateAllSources (CxList list)

Flows that starts with this instance nodes, and end with the list parameter node.

This example demonstrates the ConcatenateAllSources(CxList) method.

The input source code is:

Expand source

void main()
{
    int a = 1;
    int b = 2;
}

The source code that uses CxList.ConcatenateAllSources method:

Expand source

CxList a = All.FindByShortName("a").FindByType(typeof(Declarator));
CxList b = All.FindByShortName("b").FindByType(typeof(Declarator));
CxList main = All.FindByShortName("main");
CxList list = a + b;
result = list.ConcatenateAllSources(list);

The result would be:

Expand source

2 flow found:
[a] -> [main]
[b] -> [main]

Supported from 7.1.2

Concatenates each node in list to the node in this instance. Concatenation is node-to-node (doesn't support connecting flows).

Expand source

public CxList ConcatenateAllTargets (CxList list, bool testFlow)

Flows that starts with this instance nodes, and end with the list parameter node.

1. If the this instance contains more than one node or contains flows or list contains flows, the function return value is undefined.

2. The number of the returned items is same as the number of items in list.

3. This function calls the Concatenate function for this instance with each item in list as parameter.

This example demonstrate the ConcatenateAllTargets(CxList, bool) method.

The input source code is:

Expand source

void main()
{
    int a = 1;
    int b = 2;
}

The source code that uses CxList.ConcatenateAllTargets method:

Expand source

CxList a = All.FindByShortName("a").FindByType(typeof(Declarator));
CxList b = All.FindByShortName("b").FindByType(typeof(Declarator));
CxList main = All.FindByShortName("main");
CxList list = a + b;
result = list.ConcatenateAllTargets(list, false);

The result would be:

Expand source

2 flow found:
[main] -> [a]
[main] -> [b]

Supported from 7.1.2

Concatenates each node in list to the node in this instance. Concatenation is node-to-node (doesn't support connecting flows).

Note: Currently is identical to calling ConcatenateAllTargets with testFlow = false

Expand source

public CxList ConcatenateAllTargets (CxList list)

Flows that starts with this instance nodes, and end with the list parameter node.

This example demonstrates the ConcatenateAllTargets(CxList) method.

The input source code is:

Expand source

void main()
{
    int a = 1;
    int b = 2;
}

The source code that uses CxList.ConcatenateAllTargets method:

Expand source

CxList a = All.FindByShortName("a").FindByType(typeof(Declarator));
CxList b = All.FindByShortName("b").FindByType(typeof(Declarator));
CxList main = All.FindByShortName("main");
CxList list = a + b;
result = list.ConcatenateAllTargets(list);

The result would be:

Expand source

2 flow found:
[main] -> [a]
[main] -> [b]

Supported from 7.1.2

Concatenates two flows into one connected flow.

Expand source

public CxList ConcatenatePath (CxList secondList, bool _testFlow)

A flow that starts with this instance flow, and ends with the list parameter flow.

Both this instance and list have to contain only one flow (or one node as a private case), otherwise return value is undefined.

This example demonstrates the ConcatenatePath(CxList, bool) method.

The input source code is:

Expand source

void main()
{
    int a = 1;
    int b = 2;
}

The source code that uses CxList.ConcatenatePath method:

Expand source

CxList one = All.FindByName("1");
CxList a = All.FindByShortName("a").FindByType(typeof(Declarator)); //Declarator
is a new type defined in cXQL
CxList flow1 = a.InfluencedBy(one); // [1] -> [a]
CxList two = All.FindByName("2");
CxList b = All.FindByShortName("b").FindByType(typeof(Declarator));
CxList flow2 = b.InfluencedBy(two); // [2] -> [b]
result = flow2.ConcatenatePath(flow1, false);

The result would be:

Expand source

1 flow found:
[2] -> [b] -> [1] -> [a]

Supported from 7.1.2

Concatenates two flows into one connected flow.

Expand source

public CxList ConcatenatePath (CxList secondList)

A flow that starts with this instance flow, and ends with the list parameter flow.

Supported from 7.1.2

Returns a subset of “this” instance whose elements are contained in the given list, filtered according to the given nodes type.

Expand source

public CxList Contained (CxList pathList, GetStartEndNodesType requestedType)

A subset of “this” instance with elements from the requested nodes type.

The return value may be empty (Count = 0).

This example demonstrates the CxList.Contained(CxList, GetStartEndNodesType) method.

The input source code is:

Expand source

void foo()
{
    int b = 2, a = 5, c;
    if (a > b)
        b = 3;
    c = b;
}

The source code that uses CxList.Contained method:

Expand source

result = All.FindByShortName("b").Contained(All.InfluencedBy(All.FindById(50)), GetStartEndNodesType.AllNodes);
//Id 50 is "3" in "b = 3;"

The result would consist of 2 items:

Expand source

b (from b = 3;)
b (from c = b;)

The source code that uses CxList.Contained method:

Expand source

result = All.FindByShortName("a").Contained(All.InfluencedBy(All.FindById(50)), GetStartEndNodesType.EndNodesOnly);
// Id 50 is "3" in "b = 3;"

The result would consist of 0 items.

Supported from 7.1.2

return true if input parameter is root of at least one graph.

None

Returns a ICxListProvider which is a subset of this instance and its elements are control influenced by the specified ICxListProvider.

A subset of this instance control influenced by the specified ICxListProvider.

Returns a ICxListProvider which is a subset of this instance and its elements are control influenced by the specified ICxListProvider.

A subset of this instance control influenced by the specified ICxListProvider.

Returns a ICxListProvider which is a subset of this instance and its elements are control influenced by the specified ICxListProvider and not sanitized by the specified ICxListProvider.

A subset of this instance control influenced by the specified ICxListProvider and not sanitized.

Returns a ICxListProvider which is a subset of this instance and its elements are control influenced by the specified ICxListProvider and not sanitized by the specified ICxListProvider.

A subset of this instance control influenced by the specified ICxListProvider and not sanitized.

Returns a ICxListProvider which is a subset of this instance and its elements are control influencing on the specified ICxListProvider.

A subset of this instance control influencing on the specified ICxListProvider.

Returns a ICxListProvider which is a subset of this instance and its elements are control influencing on the specified ICxListProvider.

A subset of this instance control influencing on the specified ICxListProvider.

Returns a ICxListProvider which is a subset of this instance and its elements are control influenced by the specified ICxListProvider and not sanitized by the specified ICxListProvider.

A subset of this instance control influencing on the specified ICxListProvider and not sanitized.

return number of paths in current node

return number of paths

Return a CxList composed by CxXmlNode.

Expand source

public CxList CreateXmlNodes(XPathNavigator input, CxXmlDoc xmlDoc, int language,
bool save, int depth = 1)

Return a CxList with CxXmlNodes for the given XPath.

Save option set to true is deprecated since 9.4.0.

None

Expand source

// create an XPathDocument object
XPathDocument xmlPathDoc = new XPathDocument(xmlFileName);
// create a navigator for the xpath doc
XPathNavigator xNav = xmlPathDoc.CreateNavigator();
result = cxXPath.CreateXmlNodes(xNav, xmlDoc, 1, false, 1);
// Returns a CxList of nodes in a given CxXmlDoc.

Supported from 8.6.0

This partial class is a container for methods related to MemberAccess operations.

Returns a new CxList that includes selected property that exists in DOM type <T> and define by lambda. We can achieve the same effect by using another (old) interface.

Expand source

public CxList CxSelectDomProperty<T>(Func<T,IGraph> lambda) where T:CSharpGraph

New list of requested properties.

The return value may be empty (Count = 0).

These examples demonstrate using of CxList.CxSelectDomProperty(Func<T, IGraph>) method.

Get all TrueStatements of type IfStmt and Statements of IterationStmt:

Expand source

CxList False = Find_Always_False();
var cond = False.GetFathers();
var falseOfIf = cond.CxSelectDomProperty<IfStmt>(x => x.TrueStatements);
var falseOfIteration = cond.CxSelectDomProperty<IterationStmt>(x => x.Statements);
var falseBlock = falseOfIf + falseOfIteration;

Get some data based on "Left" property of AssignExpr:

Expand source

CxList curNodes = assignsExpr.CxSelectDomProperty<AssignExpr>(x =>x.Left);
left.Add(All.GetByAncs(curNodes));

Supported from v9.2.0

Returns list of requires property values of dom object of <TDomObject> and return list of <TOutput>. For more details see example.Main purpose of this method is hide internal CxList structure(data).

Expand source

public List<TOutput> CxSelectElementValues<TDomObject,TOutput> (Func<TDomObject,TOutput> lambda) where TDomObject:CSharpGraph

New List of all required values.

The return value may be empty (Count = 0).

This example demonstrates using of CxList.CxSelectElementValues(Func<TDomObject,TOutput>) method.

Compare parameter name of two methods (implementation and declaration) If name of parameters are different add to result method declaration and method implementation

(query “R16_04_Different_Identifiers_In_Function_Definition_And_Prototype” CPP Misra):

Expand source

var curListNames = curParams.CxSelectElementValues<ParamDecl, string>(x => x.Name);
var compListNames = compParams.CxSelectElementValues<ParamDecl, string>(x => x.Name);
for (int i = 0; i<curListNames.Count; i++)
{
    if (String.Compare(curListNames[i], compListNames[i]) != 0)
    {
        result.Add(curMethodDecl + compMethodDecl);
        break;
    }
}

Supported from v9.2.0

Returns a new CxList of all required elements of input CxList. Main purpose of interface is hide internal DOM and CxList structures.

Expand source

public CxList CxSelectElements<T>(Func<T,IGraph> lambda, int option) where T:CSharpGraph

New list of requested properties.

The return value may be empty (Count = 0).

These examples demonstrate using of CxList.CxSelectElements(Func<T, IGraph>, int) method.

Get first element of Indices of input CxList (query "Value_Shadowing" C# medium):

Expand source

CxList variables = All.FindByType(typeof(IndexerRef));
CxList problematic = variables.FindByTypes(new string[]
{"Request","HttpRequest"});
result = problematic.CxSelectElements<IndexerRef>(x=>x.Indices,0);

query Find_Array_Indexes (GO, general):

Expand source

CxList arraysOrSlices = Find_IndexerRefs();
result = arraysOrSlices.CxSelectElements<IndexerRef>(x=>x.Indices);

Supported from v9.2.0

Returns a CxList which is a subset of this instance and its elements are data influenced by the CxList specified in the first parameter using the influence algorithm specified in the second parameter.

Expand source

public CxList DataInfluencedBy(CxList influencing, InfluenceAlgorithmCalculation algorithm)

A subset of “this” instance data influenced by the specified CxList.

The return value may be empty (Count = 0).

This example demonstrates the CxList.DataInfluencedBy(CxList, InfluenceAlgorithmCalculation) method.

The input source code is:

Expand source

int b, a = 5;
if (a > 3)
b = a;

The source code that uses CxList.DataInfluencedBy method:

Expand source

CxList five = All.FindByName("5");
result = All.DataInfluencedBy(five);

The result would be:

Expand source

6 items found:
a (in a = 5),
a (in a > 3),
> (in a > 3),
a (in b = a),
= (in b = a),
b (in b = a)

Returns a CxList which is a subset of “this” instance and its elements are data influenced by the CxList specified in parameter.

This call is equivalent to the following calls and it is recommended to use the short call format by default:

Expand source

public CxList DataInfluencedBy(CxList influencing)

A subset of “this” instance data influenced by the specified CxList.

The return value may be empty (Count = 0).

This example demonstrates the CxList.DataInfluencedBy(CxList) method.

The input source code is:

Expand source

int b, a = 5;
if (a > 3)
b = a;

The source code that uses CxList.DataInfluencedBy method:

Expand source

CxList five = All.FindByName("5");
result = All.DataInfluencedBy(five);

The result would be:

Expand source

6 items found:
a (in a = 5),
a (in a > 3),
> (in a > 3),
a (in b = a),
= (in b = a),
b (in b = a)

Returns a CxList which is a subset of “this” instance and its elements are data influencing on the CxList specified in the first parameter using the influence algorithm specified in the second parameter.

Expand source

public CxList DataInfluencingOn(CxList influenced, InfluenceAlgorithmCalculation algorithm)

A subset of “this” instance data influencing on the specified CxList.

The return value may be empty (Count = 0).

This example demonstrate the CxList.DataInfluencingOn(CxList, CxList.InfluenceAlgorithmCalculation) method.

The input source code is:

Expand source

int b, a = 5;
if (a > 3)
b = a;

The source code that uses CxList.DataInfluencingOn method:

Expand source

CxList b = All.FindByName("*.b");
result = All.DataInfluencingOn(b);

The result would be:

Expand source

3 items found:
a (in b = a),
a (in a = 5),
5 (in a = 5)

Returns a CxList which is a subset of “this” instance and its elements are data influencing on the CxList specified in parameter.

This call is equivalent to the following calls and it is recommended to use the short call format by default:

Expand source

public CxList DataInfluencingOn(CxList influenced)

A subset of “this” instance data influencing on the specified CxList.

The return value may be empty (Count = 0).

This example demonstrate the CxList.DataInfluencingOn(CxList, InfluenceAlgorithmCalculation) method.

The input source code is:

Expand source

int b, a = 5;
if (a > 3)
b = a;

The source code that uses CxList.DataInfluencingOn method:

Expand source

CxList b = All.FindByName("*.b");
result = All.DataInfluencingOn(b, CxList.InfluenceAlgorithmCalculation.NewAlgorithm);

The result would be:

Expand source

3 items found:
a (in b = a),
a (in a = 5),
5 (in a = 5)

Checks if a given definition is not null or empty

None

Replaces comments of specific languages with spaces, distinguishing between the language comment types.

The contents of the file with comments replaced with white spaces

Gets the elements with the specified System.Xml.Linq.XName.

A System.Xml.Linq.XElement that matches the specified System.Xml.Linq.XName, or null.

Extracts the parameters of the given keyword from a SOQL statement into a list.

Expand source

public List<string> ExtractFromSOQL(string keyword)

A list with the parameters of the keyword.

This example demonstrates the CxList.ExtractFromSOQL() method.

The input source code is:

Expand source

int b = 0;
String a = "select* from table where x=" + b;
List <String> result = All.ExtractFromSOQL("select");

The source code that uses CxList.ExtractFromSOQL() method:

Expand source

result = All.CallingMethodOfAny(All.FindByName ("oo"));

The result would consist of 1 item:

Expand source

["*"]

Extracts the parameters of a SOQL statement into a dictionary.

Expand source

public Dictionary<String, List<String>> ExtractFromSOQL()

A dictionary with keys that match SOQL keywords and their relevant parameters.

This example demonstrates the CxList.ExtractFromSOQL() method.

The input source code is:

Expand source

int b = 0;
String a = "select* from table where x=" + b;
Dictionary <String, List<String>> result = All.ExtractFromSOQL();

The source code that uses CxList.ExtractFromSOQL() method:

Expand source

result = All.CallingMethodOfAny(All.FindByName ("oo"));

The result would consist of 3 results:

Expand source

{ "select" : "*",
 "from" : "table",
 "where" : "x=" }

Fill graphs from one root element.

Expand source

public void FillGraphsList (CSharpGraph graphRoots)

None.

This example demonstrates the CxList. FillGraphsList () method.

With any Input source code, the method can be called after a Query.

Expand source

first=All.GetFirstGraph();
FillGraphsList(first);

At this point, the first is filled with the Graphs.

This method implements a new filter. It returns subset of “this”. It is very similar to “Where” of LINQ.

Expand source

public CxList Filter(Func<DOMProperties, bool> condition);

A subset of "this" instance, with elements that fulfilled lambda condition in the given CxList.

The return value may be empty (Count = 0).

These examples demonstrate using of CxList.Filter(Func<DOMProperties, bool>) method.

Get all Dom object with short name less than 50 characters:

Expand source

result = tempResult.Filter(x => x.ShortName.Length < 50);

This example demonstrates using of the CxList.Filter() and GetDOMPropertiesOfFirst methods.

Expand source

CxList sanitizers = All.NewCxList();
// Get all the elements that appear only after the position (line) of the header
foreach(CxList header in good_content_header_methods)
{
    int HeaderLineNumber = header.GetDOMPropertiesOfFirst().Line;
    CxList methods_after_header = possible_sanitizers.GetByAncs(header.GetFathers().GetFathers());
    sanitizers.Add(methods_after_header.Filter(x => x.Line >= HeaderLineNumber));
}

Supported from v9.2.0

Returns a CxList which is a subset of “this” instance, with elements that match input lambda method.

Expand source

public CxList FilterByDomProperty<T>(Func<T, bool> condition) where T: CSharpGraph;

A subset of “this” instance, with elements that fulfilled lambda condition in the given CxList.

The return value may be empty (Count = 0).

This example demonstrates using of CxList.FilterByDomProperty<(Func<T, bool>) method.

Get all AssignExpr with operator equal to AdditionAssign:

Expand source

CxList assignAdd = assignments.
FilterByDomProperty<AssignExpr>(x =>x.Operator == AssignOperator.AdditionAssign);

Supported from v9.2.0

Returns a CxList which is a subset of “this” instance, with elements that are objects from CxEngine Plugins removed.

Expand source

public CxList FilterPlugins(void);

A subset of "this" instance, with elements that are declared in the CxEngine plugins removed.

The return value may be empty (Count = 0).

These examples demonstrate using of CxList.FilterPlugins() method.

Consider processing C code

Expand source

Void main(void)
{
    Void* ptr = malloc(sizeof(int));
    return 0;
}

The source code that uses CxList.FilterPlugins method:

Expand source

CxList mallocDef = All.FindByType<MethodDecl>().FindByName("malloc");
// this list contains one node, the definition of malloc in stdlib.h
CxList localMallocDef = mallocDef.FilterPlugin();
// this list would be empty

Supported from v9.5.1

Returns a ICxListProvider which is a subset of this instance, with elements that are members of the declarations in the specified ICxListProvider.

A subset of this instance, with elements that are members of declarationsList.

Returns a CxList which is a subset of this instance, with elements that are members of the declarations in the specified CxList.

None

Returns a CxList which is a subset of “this” instance, with elements that are references of the given CxList, excluding elements in the second CxList.

Expand source

public CxList FindAllReferences(CxList ids, CxList exclude)

A subset of “this” instance, with elements that are references of the given CxList.

The return value may be empty (Count = 0).

This example demonstrates the CxList.FindAllReferences() method.

The input source code is:

Expand source

int b, a = 5;
if (a > 3)
    b = a;

The source code that uses CxList.FindAllReferences method:

Expand source

result = All.FindAllReferences(All.FindById(36), All.FindById(30)); //a in (a = 5), b in (int b)

The result would consist of 3 items:

Expand source

a (in a = 5)
a (in a > 5)
a (in b = a)

Returns a CxList which is a subset of “this” instance, with elements that are references of the given CxList.

Expand source

public abstract CxList FindAllReferences(CxList Ids)

A subset of “this” instance, with elements that are references of the given CxList.

The return value may be empty (Count = 0).

This example demonstrates the CxList.FindAllReferences() method.

The input source code is:

Expand source

int b, a = 5;
if (a > 3)
    b = a;

The source code that uses CxList.FindAllReferences method:

Expand source

result = All.FindAllReferences(All.FindById(36)); //a in (a = 5)

The result would consist of 3 items;

Expand source

a (in a = 5),
a (in a > 5),
a (in b = a)

Returns a ICxListProvider which is a subset of this instance, with elements that are references of the specified ICxListProvider.

A subset of this instance, with elements that are references of the specified ICxListProvider.

Returns a CxList which is a subset of this instance whose elements have an abstract value that fulfills the criterion.

Expand source

public CxList FindByAbstractValue (Func<IAbstractValue, bool> criterion)

A subset of this instance whose elements have match the requested criterion.

These examples demonstrate the CxList.FindByAbstractValue(Func<IAbstractValue, bool>) method.

Find all DOM elements whose abstract value is an integer inside the interval 0,10:

Expand source

IAbstractValue intervalZeroToTen = new IntegerIntervalAbstractValue(0,10);
CxList res = All.FindByAbstractValue(abstractValue =>
abstractValue.IncludedIn(intervalZeroToTen, true));

Find all DOM elements for which the integer 0 in inside their abstract value:

Expand source

IAbstractValue zero = new IntegerIntervalAbstractValue(0);
CxList res = All.FindByAbstractValue(abstractValue =>
zero.IncludedIn(abstractValue));

Find all DOM elements whose abstract value has a given type:

Expand source

CxList res = All.FindByAbstractValue(abstractValue => abstractValue is StringAbstractValue);

The input source code is:

Expand source

int counter = 0;
int x = counter + 5;
string str = "a";
string secondStr = str + "b";

The source code that uses CxList.FindByAbstractValue method:

Expand source

CxList a = All. FindByAbstractValue(abstractValue =>
abstractValue is IntegerIntervalAbstractValue);
CxList b = All.FindByAbstractValue(abstractValue =>
abstractValue is StringAbstractValue);
result = a;
// result now holds 0, '+', 'counter' and 5 in
int counter = 0;
int x = counter + 5;
result = b;
// result now holds "a", '+', 'str' and "b" in
string str = "a";
string secondStr = str + "b";

The input source code is:

Expand source

var y;
int counter = 0;
int x = counter + 5;
y();

The source code that uses CxList.FindByAbstractValue method:

Expand source

IAbstractValue zeroAbsValue = new IntegerIntervalAbstractValue(0);
result = All. FindByAbstractValue(abstractValue =>
zeroAbsValue.IncludedIn(abstractValue));
/* result now holds 0 and 'counter' in
int x = counter + 5;
And also contains y in: (because y has AnyAbstractValue which includes 0)
y();
*/
result = All. FindIncludedAbstractValue(abstractValue =>
zeroAbsValue.IncludedIn(abstractValue,true));
// result now holds 0 and 'counter' in
int x = counter + 5;
// it does not contain y because we asked for strictTypeMatch

The input source code is:

Expand source

int counter = 0;
int x = counter + 5;
function foo() { } // void method
foo();

The source code that uses CxList.FindByAbstractValue method:

Expand source

IAbstractValue zeroToFiveAbsValue = new IntegerIntervalAbstractValue(0,5);
result = All.FindIncludedInAbstractValue(abstractValue =>
abstractValue.IncludedIn(zeroToFiveAbsValue));
/* result now holds 0, 5, 'counter' and the sum (counter + 5) in
int counter = 0;
int x = counter + 5;
And also contains foo in:
foo(); // because y has AnyAbstractValue which includes [0,5]
*/
result = All.FindIncludedInAbstractValue(abstractValue =>
abstractValue.IncludedIn(zeroToFiveAbsValue, true));
// result now holds 0, 5, 'counter' and the sum of (counter + 5) in
int x = counter + 5;
// it does not contain foo because we asked for strictTypeMatch

Supported from version 8.6.0

Returns a CxList which is a subset of this instance whose elements have an abstract value equal to the abstract value of one element in the sources CxList.

Expand source

public CxList FindByAbstractValues(CxList sources)

A subset of this instance whose elements have an abstract value equal to the abstract value of one element in the sources CxList.

These examples demonstrate the CxList.FindByAbstractValue(CxList) method.

The input source code is:

Expand source

string str = "a";
string secondStr = str + "b";

The source code that uses CxList.FindByAbstractValues method:

Expand source

result = All.FindByAbstractValues(All.FindByType(typeof(StringLiteral)));
// result now holds "a", 'str' and "b" in
string str = "a";
string secondStr = str + "b";

Supported from version 8.4.2

Returns a ICxListProvider which is a subset of this instance and its elements are being on the specified side of an assignment expression.

A subset of this instance on the specified side of an assignment expression.

Returns a ICxListProvider which is a subset of this instance and its elements are custom attributes of the specified name.

A subset of this instance with custom attributes of the specified name.

Returns a ICxListProvider which is a subset of this instance and its elements are the ones which their specified member is accessed.

Expand source

public CxList FindByExactMemberAccess(string Name)

A subset of “this” instance where its elements are the ones which their given member is accessed.

The return value may be empty (Count = 0).

These examples demonstrate CxList.FindByExactMemberAccess(string) method.

The input source code is:

Expand source

MyClass a;
int b;
a.DataMember = 3;
b = a.Method();

The source code that uses CxList.FindByExactMemberAccess method:

Expand source

result = All.FindByExactMemberAccess("MyClass.DataMember");

Notice that the result would consist of 1 item:

Expand source

a.DataMember (in a.DataMember = 3)

Expand source

result = All.FindByExactMemberAccess("Class.DataMember");

The result would consist of 0 items, because "Class" is not equal to "MyClass".

Supported from 8.2.0

Receives a qualified notation string (e.g. "T.M") where T is a type name and M is a member name.

Returns a CxList which is a subset of "this" instance containing the elements with name equal to M and belong to a type whose name equals T.This search allows both case-sensitive and non case-sensitive searches.

Expand source

public CxList FindByExactMemberAccess(string Name, bool caseSensitive)

A subset of “this” instance where its elements are the ones which their specified member is accessed.

The return value may be empty (Count = 0).

These examples demonstrate the CxList.FindByExactMemberAccess(string, bool) method.

The input source code is:

Expand source

MyClass a;
int b;
a.DataMember = 3;
b = a.Method();

The source code that uses CxList.FindByExactMemberAccess method:

Expand source

result = All.FindByExactMemberAccess("MyClass.dataMember", true);

Notice that the result would consist of 0 items because the search is case-sensitive.

Expand source

result = All.FindByExactMemberAccess("MyClass.dataMember", false);

The result would consist of 1 item:

Expand source

a.DataMember (in a.DataMember = 3)

Expand source

result = All.FindByExactMemberAccess("Class.dataMember", false);

The result would consist of 0 items, because “Class” is not equals to “MyClass”.

Supported from 8.2.0

Returns a CxList which is a subset of “this” instance containing the elements with name equal to the string in second parameter belong to a type whose name equals the string in the first parameter.This is a case-sensitive search by parameters.

For a non case-sensitive search, use the FindByExactMemberAccess Method(string, string, bool) instead.

Expand source

public CxList FindByExactMemberAccess(string TargetTypeName, string MemberName)

A subset of “this” instance where its elements are the ones which their specified member is accessed.

The return value may be empty (Count = 0).

These examples demonstrate the CxList.FindByExactMemberAccess(string, string) method.

The input source code is:

Expand source

MyClass a;
int b;
a.DataMember = 3;
b = a.Method();

The source code that uses CxList.FindByExactMemberAccess method:

Expand source

result = All.FindByExactMemberAccess("MyClass", "DataMember");

Notice that the result would consist of 1 item:

Expand source

a.DataMember (in a.DataMember = 3)

Expand source

result = All.FindByExactMemberAccess("Class", "DataMember");

The result would consist of 0 items, because "Class" is not equals to "MyClass".

Supported from 8.2.0

Returns a CxList which is a subset of “this” instance containing the elements with name equal to the string in second parameter and belong to a type whose name equals the string in the first parameter.This search allows both case-sensitive and non case-sensitive searches by both parameters.

Expand source

public CxList FindByExactMemberAccess(string TargetTypeName, string MemberName, bool CaseSensitive)

A subset of “this” instance where its elements are the ones which their specified member is accessed.

The return value may be empty (Count = 0).

These examples demonstrate the CxList.FindByExactMemberAccess(string, string, bool) method.

The input source code is:

Expand source

MyClass a;
int b;
a.DataMember = 3;
b = a.Method();

The source code that uses CxList.FindByExactMemberAccess method:

Expand source

result = All.FindByExactMemberAccess("MyClass", "dataMember", true);

Notice that the result would consist of 0 item because it is a case-sensitive search.

Expand source

result = All.FindByExactMemberAccess("MyClass", "dataMember", false);

The result would consist of 1 item:

Expand source

a.DataMember (in a.DataMember = 3)

Expand source

result = All.FindByExactMemberAccess("Class", "dataMember", false);

The result would consist of 0 items, because "Class" is not equals to "MyClass".

Supported from 8.2.0

Returns a CxList which is a subset of "this" instance with nodes that are part of a member/target pair (typical example: target.member) and have a direct member in the CxList parameter "members". Returns a CxList which is a subset of this instance and its elements are the ones which their specified members and targets are accessed. It only works if all the Members are mutual for all the Targets (Types) e.g. myClass1.method1(); myClass1.method2(); myClass2.method1(); myClass2.method2();

A subset of this instance and its elements are the ones which their specified members and targets are accessed

Returns a CxList which is a subset of this instance and its elements are the ones which their specified members and a single target accessed. It only works if all the Members are mutual for all the Targets (Types) e.g. myClass1.method1(); myClass1.method2(); myClass1.method3();

A subset of this instance and its elements are the ones which their specified members and a single target accessed

Returns a CxListImpl which is a subset of this instance and its elements are MemberAccesses specified on the parameter <paramref name="names"></paramref>.

A subset of this instance where its elements are the ones which their specified member is accessed.

Returns a CxList which is a subset of "this" instance and the type of its elements match the type specified as parameter.

Expand source

public CxList FindByExtendedType (string extendedType)

A subset of "this" instance and its elements are those with type specified by the parameter.

The return may be empty (Count = 0).

This example demonstrates the CxList.FindByExtendedType() method.

The input source code is:

Expand source

MyClass a;
MyClassExtended b;
int c;
a.DataMember = 3;
c = a.Method();

The source code that uses CxList.FindByExtendedType method:

Expand source

result = All.FindByExtendedType("MyClass*");

The result would consists of 4 items:

Expand source

a (in MyClass a)
b (in MyClassExtended b)
a (in a.DataMember = 3)
a (in c = a.Method())

Returns a ICxListProvider which is a subset of this instance and its elements are those that their CxDOM are in the specified ICxListProvider

A subset of this instance and its elements are those that their CxDOM-Fathers are in the specified ICxListProvider.

Returns a ICxListProvider which is a subset of this instance and its elements are modified by the modifier (private, external, etc).

A subset of this instance and its elements are those with attribute attrib.

Returns a ICxListProvider which is a subset of this instance and its elements are in a given source code file.

A subset of this instance in a given file name.

Returns a ICxListProvider which is a subset of this instance and its elements are in a given source code file.

A subset of this instance in a given file name.

Returns a CxList, which is a subset of “this” instance and its elements are in a given array of source code files.

Expand source

public CxList FindByFileNames(params string[] FileNames)

A subset of "this” instance with elements from a given list of file names.

The return value may be empty (Count = 0).

This example demonstrates the CxList.FindByFileNames(string[]) method.

Expand source

//file myCode1.cs
class Cl1
{
    void foo()
    {
        int i;
    }
}
//file myCode2.cs
class Cl2
{
    void bar()
    {
        int i;
    }
}

The source code that uses CxList.FindByFileNames method:

Expand source

result = All.FindByFileNames("*myCode1.cs", "*myCode2.cs");

The result would consist of 10 items:

Expand source

Cl1
void,
foo,
int,
i,
Cl2
void,
 bar,
int,
i

Supported from 9.4

Returns a subset of 'this' instance, where its DOM objects are on the same file(s) as the DOM objects in the 'source' CxList.

Expand source

public CxList FindByFiles(CxList source)

Returns Return a subset of 'this' instance, where its DOM objects are on the same file(s) as the DOM objects in the 'source' CxList.

This example demonstrates the CxList.FindByFiles(CxList) method.

Expand source

CxList a = All.FindByFileName("*method.js*");
CxList b = All.FindByFileName("*method.json");
result = a.FindByFiles(b);
// Return a subset of 'a' where the objects are of the same file as the objects of b.

Supported from 8.4.0

Finds all objects with the specified id. This method is mainly used to find all the uses of a code element (e.g. variable, class).

Expand source

public CxList FindById (int id)

A subset of "this" instance and its elements that have the specified id number.

The return value may be empty(Count = 0).

This example demonstrates the CxList.FindById() method.

The input source code is:

Expand source

a = 3;
b = 4;
if (a == 4)
    b = a - 1;

The source code that uses CxList.FindById method:

Expand source

result = All.FindById(60);

The result would be -

Expand source

1 item found:
    b ( in b = a - 1)

Finds an object with the specified ids.

A subset of this instance with the specified id numbers.

Returns a CxList which is a subset of “this” instance and contains elements initialized by the given CxList.

Expand source

public CxList FindByInitialization(CxList InitializersList)

A subset of “this” instance containing declarators initialized by the specified CxList.

The return value may be empty (Count = 0).

This example demonstrate the CxList.FindByInitialization(CxList) method.

The input source code is:

Expand source

int b = 5;

The source code that uses CxList.FindByInitialization method:

Expand source

CxList declarators = All.FindByType(typeof(Declarator));
result= declarators.FindByInitialization(All);

The result would consist of 1 item:

Expand source

b

Supported from v1.8.1

Returns a CxList which is a subset of “this” instance whose elements are from the given language.

Expand source

public CxList FindByLanguage (string languageName)

A subset of “this” instance whose elements are from the given language.

The return value may be empty (Count = 0).

This example demonstrates the CxList.FindByLanguage(CxList) method.

The input source code is:

Expand source

//file myCode.cs
class myCode
{
}
//file MyCode.java
class MyCode
{
}

The source code that uses CxList.FindByLanguage method:

Expand source

result = All.FindByLanguage ("Java");

The result would consist of 1 item:

Expand source

myCode (class MyCode)

Receives a qualified notation string (e.g. “T.M”) where T is a type name and M is a member name.

Returns a CxList which is a subset of “this” instance containing the elements with name equal to M and belong to a type whose name ends with T.This search allows both case-sensitive and non case-sensitive searches.

For a search by exact target type name, use FindByExactMemberAccess(string) instead.

Expand source

public CxList FindByMemberAccess(string Name, bool CaseSensitive = true)

A subset of “this” instance where its elements are the ones which their specified member is accessed.

The return value may be empty (Count = 0).

These examples demonstrate the CxList.FindByMemberAccess(string, bool) method.

The input source code is:

Expand source

MyClass a;
int b;
a.DataMember = 3;
b = a.Method();

The source code that uses CxList.FindByMemberAccess method:

Expand source

result = All.FindByMemberAccess("MyClass.dataMember", true);

Notice that the result would consist of 0 items because the search is case-sensitive.

Expand source

result = All.FindByMemberAccess("Class.dataMember", false);

Notice that the result would consist of 1 item:

Expand source

a.DataMember (in a.DataMember = 3)

This is so, because MyClass ends with Class.

Expand source

result = All.FindByMemberAccess("MyClass.met*", true);

Notice that the result would consist of 0 items because the search is case-sensitive.

Expand source

result = All.FindByMemberAccess("Class.dataMember", false);

Notice that the result would consist of 1 item:

Expand source

a.Method(in b = a.Method())

Supported from 1.8.1

Returns a CxList which is a subset of “this” instance containing the elements with name equal to the string in the second parameter and belong to a type whose name ends with the string in the first parameter. This is a case-sensitive search by both parameters.

Expand source

public CxList FindByMemberAccess(string TargetTypeName, string MemberName, bool CaseSensitive = true)

A subset of “this” instance where its elements are the ones which their specified member is accessed.

The return value may be empty (Count = 0).

These examples demonstrate the CxList.FindByMemberAccess(string, string, bool) method.

The input source code is:

Expand source

MyClass a;
int b;
a.DataMember = 3;
b = a.Method();

The source code that uses CxList.FindByMemberAccess method:

Expand source

result = All.FindByMemberAccess("MyClass", "dataMember", true);

Notice that the result would consist of 0 items because the search is case-sensitive.

Expand source

result = All.FindByMemberAccess("MyClass", "dataMember", false);

The result would consist of 1 item:

Expand source

a.DataMember (in a.DataMember = 3)

This is so, because MyClass ends with Class.

Expand source

result = All.FindByMemberAccess("MyClass", "met*", true);

Notice that the result would consist of 0 items because the search is case-sensitive.

Expand source

result = All.FindByMemberAccess("MyClass", "met*", false);

the result would consist of 1 item:

Expand source

a.Method(in b = a.Method())

Receives an array of qualified notation strings (e.g. “T.M”) where T is a type name and M is a member name.

Returns a CxList which is a subset of “this” instance containing the elements with name equal to M and belong to a type whose name ends with T, for any strings in the array. This search allows both case-sensitive and non case-sensitive searches.

Expand source

public CxList FindByMemberAccesses(string [] Names, bool CaseSensitive = true)

A subset of “this” instance where its elements are the ones which their specified members are accessed.

The return value may be empty (Count = 0).

These examples demonstrate the CxList.FindByMemberAccesses(string, bool) method.

The input source code is:

Expand source

MyClass a;
int b;
a.DataMember = 3;
b = a.Method();

The source code that uses CxList.FindByMemberAccesses method:

Expand source

string []memberAccesses = new string[]{“Class.dataMember”, “MyClass.Met*”}
result = All.FindByMemberAccesses(memberAccesses, true);

Notice that the result would consist of 1 item because the search is case-sensitive:

Expand source

a.Method()

Expand source

result = All.FindByMemberAccesses(memberAccesses);

The result would consist of 2 items:

Expand source

a.DataMember
a.Method

This is so, because MyClass ends with Class.

Supported from 8.2.0

Receives a qualified notation string (e.g. “T.M”) where T is a type name and M is a member name.

Returns a CxList which is a subset of “this” instance containing the elements with name equal to M and belong to a type whose name equals T.This is a case sensitive search.

For a non case-sensitive search, use the FindByExactMemberAccess (string, bool) instead. Returns a CxList which is a subset of this instance and its elements are the ones which their specified members and targets are accessed. It only works if all the Members are mutual for all the Targets (Types) e.g. myClass1.method1(); myClass1.method2(); myClass2.method1(); myClass2.method2();

A subset of this instance and its elements are the ones which their specified members and targets are accessed

Returns a CxList which is a subset of this instance and its elements are the ones which their specified members and a single target accessed. It only works if all the Members are mutual for all the Targets (Types) e.g. myClass1.method1(); myClass1.method2(); myClass1.method3();

A subset of this instance and its elements are the ones which their specified members and a single target accessed

Returns a CxList which is a subset of “this” instance and its elements are method declarators of a given return type.

Expand source

public CxList FindByMethodReturnType(string type)

A subset of “this” instance with method declarators of a given return type.

1. If the this instance contains more than one node or contains flows or list contains flows, the function return value is undefined.

2. The number of the returned items is same as the number of items in list.

3. This function calls the Concatenate function for this instance with each item in list as parameter.

This example demonstrate the CxList.FindByMethodReturnType(string) method.

The input source code is:

Expand source

MyType foo() {
    ...
}

The source code that uses CxList.FindByMethodReturnType method:

Expand source

result = All.FindByMethodReturnType("MyType");

The result would consist of 1 item:

Expand source

foo

Returns a CxList which is a subset of “this” instance and its elements are the ones which their name is the given parameter(optionally with wildcards) and is not shorter than minLength and not longer than maxLength.

Expand source

public CxList FindByName(string nodeName, int minLength, int maxLength)

A subset of “this” instance and its elements are the ones which their name is the given parameter, according to the given length interval.

The return value may be empty (Count = 0).

This example demonstrate the CxList.FindByName(string, int, int) method.

The input source code is:

Expand source

MyClass a;
int b;
a.DataMember = 3;
b = a.Method();

The source code that uses CxList.FindByName method:

Expand source

result =  All.FindByName("*Me*", 3, 7);

The result would consist of 1 item:

Expand source

Method (in b = a.Method())

Supported from v2.0.5

Returns a CxList which is a subset of “this” instance and its elements are the ones which their names are equal to the given list.

Expand source

public CxList FindByName(CxList nodesList)

A subset of “this” instance and its elements are the ones which the name is contained in the given list.

The return value may be empty (Count = 0).

This example demonstrate the CxList.FindByName(CxList) method.

The input source code is:

Expand source

MyClass a;
int b;
a.DataMember = 3;
b = a.Method();

The source code that uses CxList.FindByName method:

Expand source

result =  All.FindByName(All.FindByType(typeof(MemberAccess)));

The result would consist of 3 items:

Expand source

a (in MyClass a)
a (in a.DataMember = 3)
a (in b = a.Method())

Returns a CxList which is a subset of “this” instance and its elements are the ones which their names are equal to the list given.

Expand source

public CxList FindByName(CxList nodesList, bool CaseSensitive)

A subset of “this” instance and its elements are the ones which their name is contained in the given list, according to the specified case sensitivity comparison criteria.

The return value may be empty (Count = 0).

This example demonstrate the CxList.FindByName(CxList, bool) method.

The input source code is:

Expand source

MyClass A;
int a;
A.DataMember = 3;
a = A.Method();

The source code that uses CxList.FindByName method:

Expand source

result =  All.FindByName(All.FindByType(typeof(MemberAccess)), false));

The result would consist of 5 items:

Expand source

A (in MyClass A)
a (in int a)
A (in A.DataMember = 3)
a (in a = A.Method())
A (in a = A.Method())

Returns a CxList which is a subset of “this” instance and its elements are the ones which their name is the given parameter.

Expand source

public CxList FindByName(string name)

A subset of “this” instance and its elements are the ones which their name is the given parameter.

1. If the this instance contains more than one node or contains flows or list contains flows, the function return value is undefined.

2. The number of the returned items is same as the number of items in list.

3. This function calls the Concatenate function for this instance with each item in list as parameter.

This example demonstrate the CxList.FindByName(string) method.

The input source code is:

Expand source

MyClass a;
int b;
a.DataMember = 3;
b = a.Method();

The source code that uses CxList.FindByName method:

Expand source

result =  All.FindByName("*Member*");

The result would consist of 1 item:

Expand source

a.DataMember (in a.DataMember = 3)

Returns a CxList which is a subset of “this” instance and its elements are the ones which their name is the given parameter, according to the specified comparison criteria.

Expand source

public CxList FindByName(string name, bool CaseSensitive)

A subset of “this” instance and its elements are the ones which their name is the given parameter, according to the given comparison criteria.The caseSensitive boolean value defines the ability to search using case sensitive or case insensitive comparison.

The return value may be empty (Count = 0).

This example demonstrate the CxList.FindByName(string, bool) method.

The input source code is:

Expand source

MyClass a;
int b;
a.DataMember = 3;
b = a.Method();

The source code that uses CxList.FindByName method:

Expand source

result = All.FindByName("*member*", true);

The result would consist of 0 items.

Expand source

result = All.FindByName("*member*", false);

The result would consist of 1 item:

Expand source

a.DataMember (in a.DataMember = 3)

Supported from v1.8.1

Returns a CxList which is a subset of “this” instance and its elements are the ones which their name is the given parameter. The comparison method specified in parameter is used for matching.

Expand source

public CxList FindByName(string name, StringComparison comparisonType)

A subset of “this” instance and its elements are the ones which their name is the given parameter.

The return value may be empty (Count = 0).

This example demonstrate the CxList.FindByName(string, StringComparison) method.

The input source code is:

Expand source

MyClass a;
int b;
a.DataMember = 3;
b = a.Method();

The source code that uses CxList.FindByName method:

Expand source

result = All.FindByName("*member*", StringComparison.OrdinalIgnoreCase));

The result would consist of 1 item:

Expand source

DataMember (in a.DataMember = 3)

Supported from v1.8.1

Returns a CxList which is a subset of “this” instance and its elements are the ones which their names are equal to the list given.

Expand source

public CxList FindByNames(params String[] nodeNames)

A subset of “this” instance and its elements are the ones which their name is contained in the given list, according to the specified case sensitivity comparison criteria. CaseSensitive is by default is true.

The return value may be empty (Count = 0).

This example demonstrate the CxList.FindByNames(params String[]) method.

The input source code is:

Expand source

MyClass A;
int a;
A.DataMember = 3;
a = A.Method();

The source code that uses CxList.FindByNames method:

Expand source

result = All.FindByNames("*MEMBER","A.Method");

The result would consist of 3 items:

Expand source

A (in A.DataMember = 3)
a (in a = A.Method())
A (in a = A.Method())

Supported from v9.4.0

Returns a CxList which is a subset of “this” instance and its elements are the ones which their names are equal to the list given.

Expand source

public CxList FindByNames(String[] nodeNames,  bool CaseSensitive = true)

A subset of “this” instance and its elements are the ones which their name is contained in the given list, according to the specified case sensitivity comparison criteria.

The return value may be empty (Count = 0).

This example demonstrate the CxList.FindByNames(String[], bool) method.

The input source code is:

Expand source

MyClass A;
int a;
A.DataMember = 3;
a = A.Method();

The source code that uses CxList.FindByNames method:

Expand source

string[] str = new string[2] {"*MEMBER","A.Method"};
result = All.FindByNames(str);

The result would consist of 3 items:

Expand source

A (in A.DataMember = 3)
a (in a = A.Method())
A (in a = A.Method())

Supported from v9.4.0

Returns a CxList which is a subset of “this” instance and its elements are the ones which their names are equal to the list given.

A subset of “this” instance and its elements are the ones which their name is contained in the given list, according to the specified comparison method.

The return value may be empty (Count = 0).

Returns a CxList which is a subset of "this" instance and its elements are nodes (method declarations, constructor, etc) with the number of parameters given.

Expand source

public CxList FindByNumberOfParameters (int numParams)

A subset of this instance with nodes (method declarations, constructor, etc) that has the number of parameters given.

The return value may be empty (Count = 0).

This example demonstrates the CxList.FindByNumberOfParameters() method.

The input source code is:

Expand source

foo("myVar");

The source code that uses CxList.FindByNumberOfParameters method:

Expand source

CxList var = All.FindByShortName("myVar");
result = All.FindByNumberOfParameters(1);

the result would consist of 1 item:

foo

Supported from v9.4

Returns a CxList which is a subset of "this", containing only MethodInvokeExpr DOM node where their arguments are labeled according to the given value.

Expand source

public CxList FindByParameterName (string paramName)

A subset of "this" instance where its elements are MethodInvokeExpr and ObjectCreateExpr and these contain arguments labelled according to 'paramName'.

The return value may be empty (Count = 0).

This example demonstrates the CxList. FindByParameterName(string) method.

The input source code is:

Expand source

class NamedExample
{
    static void Main(string [] args)
    {
        PrintOrderDetails(sellerName:"Gift Shop",31,productName:"Red Mug");
    }
}

The source code that uses CxList.FindByParameterName method:

Expand source

result = All.FindByParameterName("sellerName");

The resul would consist in 1 item:

Expand source

PrintOrderDetails

Returns a CxList which is a subset of "this", containing only MethodInvokeExpr DOM node where their arguments on a given position are labeled according to the given value.

Expand source

public CxList FindByParameterName (string paramName, int paramPosition)

A subset of "this" instance where its elements are MethodInvokeExpr and ObjectCreateExpr and these contain arguments labelled according to 'paramName' in the indicated position by 'paramPosition'.

The return value may be empty (Count = 0).

This example demonstrates the CxList. FindByParameterName(string, int) method.

The input source code is;

Expand source

class NamedExample
{
    static void Main(string [] args)
    {
        PrintOrderDetails(sellerName:"Gift Shop",31,productName:"Red Mug");
    }
}

The source code that uses CxList.FindByParameterName method:

Expand source

result = All.FindByParameterName ("sellerName", 1);

Would have no results because there's no argument named "sellerName" on the first position of the method call.

However,

Expand source

result = All.FindByParameterName ("productName", 1);

Would result in 1 item:

Expand source

PrintOrderDetails

Because there's an argument on the second position(zero based) called "productName"

Returns a ICxListProvider which is a subset of this instance and its parameters values are as specified.

Returns a ICxListProvider which is a subset of this instance and its parameters values are as specified.

Returns a CxList which is a subset of “this” instance and its elements are methods whose parameters values (referred by their index) are equal(or not).

Expand source

public CxList FindByParameterValue(int paramNo1, int paramNo2, BinaryOperator opr)

A subset of “this” instance whose parameter values are equal or not equal (depending on the operator chosen).

The return value may be empty (Count = 0).

This example demonstrates the CxList.GetParameters() method.

The input source code is:

Expand source

foo(1, i, 1);

The source code that uses CxList.FindByParameterValue method:

Expand source

CxList methods = All.FindByType(typeof(MethodInvokeExpr));
result = All.FindByParameterValue(0, 2, BinaryOperator.IdentityEquality);

the result would consist of 1 item:

Expand source

foo (first parameter value is equal to the third one)

Returns a CxList which is a subset of “this” instance and its elements are methods of the given CxList with the specified parameters.

Expand source

public CxList FindByParameters (CxList paramList)

A subset of "this" instance with methods whose parameters are given in the list.

The return value may be empty (Count = 0).

This example demonstrates the CxList.FindByParameters() method.

The input source code is:

Expand source

foo("myVar");

The source code that uses CxList.FindByParameters method:

Expand source

CxList var = All.FindByShortName("myVar");
result = All.FindByParameters(var);

The result would consist of 1 item:

Expand source

foo

Returns a CxList which is a subset of “this” instance and its elements are of the type pointer of the specified type of code element.

Expand source

 public CxList FindByPointerType(string type, int maxDepth, bool caseSensitive) 

A subset of "this" instance and its elements are of the type pointer of the specified type of code element.

The return value may be empty (Count = 0).

This example demonstrates the CxList.FindByPointerType method.

The input source code is:

Expand source

var i *int

The source code that uses CxList.FindByPointerType method:

Expand source

result = All.FindByPointerType(“int”);

the result would consist of 2 items:

Expand source

*int – pointer
i – Declarator

Supported from v8.5.0

Returns a CxList which is a subset of “this” instance and its elements are of the type pointer of the specified type of code element

Expand source

public CxList FindByPointerType(string type, bool caseSensitive)

A subset of "this" instance and its elements are of the type pointer of the specified type of code element.

The return value may be empty (Count = 0).

This example demonstrates the CxList.FindByPointerType method.

The input source code is:

Expand source

var i *int

The source code that uses CxList.FindByPointerType method:

Expand source

result = All.FindByPointerType("int");

the result would consist of 2 items:

Expand source

*int - pointer
I - Declarator

Supported from v8.5.0

Returns a CxList which is a subset of "this" instance and its elements are of the type pointer of the specified types of code element

Expand source

public CxList FindByPointerType(string[] type, bool caseSensitive)

A subset of "this" instance and its elements are of the type pointer of the specified types of code element.

The return value may be empty (Count = 0).

This example demonstrates the CxList.FindByPointerType method.

The input source code is:

Expand source

var i * int

The source code that uses CxList.FindByPointerType method:

Expand source

result = All.FindByPointerTypes(new string[]{"int","string"});

the result would consist of 2 items:

Expand source

*int - pointer
i - Declarator

Supported from v8.5.0

Returns a CxList which is a subset of "this" instance and its elements are of the type pointer of the specified types of code element

Expand source

public CxList FindByPointerTypes(string[] type, int maxLevels, bool caseSensitive)

A subset of “this” instance and its elements are of the type pointer of the specified types of code element.

The return value may be empty (Count = 0).

This example demonstrates the CxList.FindByPointerTypes method.

The input source code is:

Expand source

var i *int

The source code that uses CxList.FindByPointerTypes method:

Expand source

result = All.FindByPointerTypes(new string[]{"int","string"});

the result would consist of 2 items:

Expand source

*int - pointer
i - Declarator

Supported from v8.5.0

Returns a CxList which is a subset of "this" instance and its elements are located in the given file and line number.

Expand source

public CxList FindByPosition(string file, int line)

A subset of "this" instance which is located in the given file and line.

The return value may be empty (Count = 0).

This example demonstrates the CxList.FindByPosition() method.

The input source code is (file name "MyCode.java"):

Expand source

MyClass a;
int b;
a.DataMember = 5;
b = a.Method();

The source code that uses CxList.FindByPosition method:

Expand source

result = All.FindByPosition (“MyCode.java”, 3);

the result would consist of 1 item:

Expand source

5 (in a.DataMember = 5)

Returns a CxList which is a subset of “this” instance and its elements are located in the given file, line and column.

Expand source

public CxList FindByPosition(string file, int line, int col)

A subset of "this" instance which is located in the specified file, line and column.

The return value may be empty (Count = 0).

This example demonstrates the CxList.FindByPosition() method.file name "MyCode.java"

The input source code is:

Expand source

MyClass a;
int b;
a.DataMember = 5;
b = a.Method();

Expand source

result = All.FindByPosition (“MyCode.java”, 3, 16);

the result would be -

Expand source

1 item found:
    5 (in a.DataMember = 5)

Returns a CxList which is a subset of "this" instance and its elements are in the given line number.

Expand source

public CxList FindByPosition(int line)

A subset of "this" instance with elements from the given line.

The return value may be empty (Count = 0).

This example demonstrates the CxList. FindByPosition() method.

The input source code is:

Expand source

int b, a = 5;
if (a > 3)
    b = 6;

The source code that uses CxList.FindByPosition method:

Expand source

result = All.FindByPosition(2);

the result would consist of 4 items:

if

a,

>,

3

Returns a CxList which is a subset of “this” instance and its elements are located in the given line and column number.

Expand source

public CxList FindByPosition(int line, int col)

A subset of "this" instance with elements from the specified line and column.

The return value may be empty (Count = 0).

This example demonstrates the CxList.FindByPosition() method.

The input source code is:

Expand source

MyClass a;
int b;
a.DataMember = 3;
b = a.Method();

The source code that uses CxList.FindByPosition method:

Expand source

result = All.FindByPosition (3, 16);

the result would consist of 1 item:

Expand source

3 (in a.DataMember = 3)

Returns a CxList which is a subset of “this” instance and its elements are in the given line/column and with the given length.

Expand source

public CxList FindByPosition(int line, int col, int length)

A subset of "this" instance with elements from the specified line, column and with the given length.

The return value may be empty (Count = 0).

This example demonstrates the CxList. FindByPosition() method.

The input source code is:

Expand source

int b, a = 5;
if (a==33)
    b = 6;

The source code that uses CxList.FindByPosition method:

Expand source

result = All.FindByPosition(2, 5, 1);

the result would consist of 1 item:

Expand source

a

Finds the elements of "this" instance at positions given in the pragmas list.

Expand source

public CxList FindByPositions(SortedList pragmas, int extendMatch, bool oneOnly)

The elements from "this" instance that are at the required positions.

The return value may be empty (Count = 0).

This example demonstrates the CxList.FindByPositions() method.

The input source code is:

Expand source

int b, a = 5;
if (a == 33)
    b = 6;

The source code that uses CxList.FindByPositions method:

Expand source

CxList list = All.FindByShortName("b");
SortedList sorted = new SortedList(new PragmaComparer());
foreach (KeyValuePair<int, IGraph> dic in list.data)
{
    sorted.Add(dic.Value.LinePragma, null);
}
result = All.FindByPositions(sorted, 1, true);

the result would consist of 2 items:

Expand source

b (in int b)
b (in b = 6)

Finds the elements of "this" instance at positions given in the list using the proximity given in parameter.

The elements of "this" instance that are at the given positions.

The return value may be empty (Count = 0).

This example demonstrates the CxList. FindByPositions() method.

The input source code is:

Expand source

int b, a = 5;
if (a == 33)
    b = 6;

The source code that uses CxList.FindByPositions method:

Expand source

CxList list = All.FindByName(“b”);
result = All.FindByPositions(list, CxPositionProximity.FindInLine, false);

The result would be all the elements in the 5 lines closer to lines that appear variable b:

Expand source

2 items found
    b (in int b)
    b (in b = 6)

Finds the elements of “this” instance at positions given in the pragmas list using the proximity from the parameter.

Expand source

public CxList FindByPositions(SortedList<LinePragma,object> pragmas, CxPositionProximity extendMatch, bool oneOnly)

The elements from the current instance that are at the required positions.

The return value may be empty (Count = 0).

This example demonstrates the CxList. FindByPositions() method.

The input source code is:

Expand source

int b, a = 5;
if (a == 33)
    b = 6;

The source code that uses CxList.FindByPositions method:

Expand source

CxList list = All.FindByName(“b”);
SortedList<LinePragma, object> sorted = new SortedList<LinePragma, object>(new DataCollections.PragmaComparer());
foreach (KeyValuePair<int, IGraph> dic in list.data)
{
    sorted.Add(dic.Value.LinePragma, null);
}
result = All.FindByPositions(sorted, CxList.CxPositionProximity.FindInLine, true);

The result would consist of 2 items:

Expand source

b (in int b)
b (in b = 6)

Finds the elements of “this” instance at positions given in the pragmas list using the proximity given in parameter.

The elements from "this" instance that are at the given positions.

The return value may be empty (Count = 0).

This example demonstrates the CxList. FindByPositions() method.

The input source code is:

Expand source

int b, a = 5;
if (a == 33)
    b = 6;

The source code that uses CxList.FindByPositions method:

Expand source

CxList list = All.FindByName(“b”);
SortedList<LinePragma, object> sorted = new SortedList<LinePragma, object>(new DataCollections.PragmaComparer());
foreach (KeyValuePair<int, IGraph> dic in list.data)
{
    sorted.Add(dic.Value.LinePragma, null);
}
result = All.FindByPositions(sorted, CxList.CxPositionProximity.FindInLine, true, 5);

The result would consist of 2 items:

Expand source

b (in int b)
b (in b = 6)

Finds the elements of "this" instance at lines of files given in parameter.

Expand source

public CxList FindByPositions(List<KeyValuePair<int, string>> lines)

The subset of elements from “this” instance that are in the files given at the lines requested.

The return value may be empty (Count = 0).

This example demonstrates the CxList. FindByPositions() method.

The input source code is (file name is “MyCode.cs”:

Expand source

int b, a = 5;
if (a == 33)
    b = 6;

The source code that uses CxList.FindByPositions method:

Expand source

KeyValuePair<int,string> position = new KeyValuePair<int, string>(3,”path\\MyCode.cs”);
List<KeyValuePair<int, string>> list = new List<KeyValuePair<int, string>>();
list.Add(position);
result = All.FindByPositions(list);

The result would consist of 3 items:

Expand source

b
=
6

return DOM objects by searching the source file with regex

None

Returns a CxList which is a subset of this instance and its elements match the specified regular expression string. This call is equivalent to the following calls and it is recommended to use the short call format by default:

Expand source

public CxList FindByRegex(string expression)

A subset of this instance matches the given regular expression.

The return value may be empty (Count = 0)

The following code example shows how you can use the FindByRegex method.

This example demonstrates the CxList.FindByRegex() method.

The input source code is:

Expand source

int a = 5;
if (a > 3)
    foo(a);

The source code that uses CxList.FindByRegex method:

Expand source

result = All.FindByRegex(@"(\s)?foo\(");

The result would be -

Expand source

1 item found:
    foo

Supported from: CxAudit v1.8.1

Returns a CxList which is a subset of this instance and its elements match the specified regular expression string, according to specified flag parameters. This call is equivalent to the following calls and it is highly recommended to use the enum instead of the confusing flags:

Expand source

public CxList FindByRegex(string expression , bool searchInComments, bool searchInStringLiterals, bool recursive)

A subset of this instance matches the given regular expression according to the additional parameters.

The return value may be empty (Count = 0).

The following code example shows how you can use the FindByRegex method.

This example demonstrates the CxList.FindByRegex() method.

The input source code is:

Expand source

int a = 5;
if (a > 3)
    foo(a);

The source code that uses CxList.FindByRegex method:

Expand source

result = All.FindByRegex(@"(\s)?foo\(", false, true, false);

The result would be -

Expand source

1 item found:
    foo

Supported from v1.8.1

Returns a CxList which is a subset of this instance and its elements match the specified regular expression string, according to specified Checkmarx Regex Options defined in the second parameter.

This call is equivalent to the following calls and it is recommended to use the short call format by default:

Expand source

public CxList FindByRegex(string expression , CxRegexOptions cxOptions)

A subset of this instance matches the given regular expression according to the additional parameters.

The return value may be empty (Count = 0).

The following code example shows how you can use the FindByRegex method.

This example demonstrates the CxList.FindByRegex() method.

The input source code is:

Expand source

int a = 5;
if (a > 3)
    foo(a);

The source code that uses CxList.FindByRegex method:

Expand source

result = All.FindByRegex(@"(\s)?foo\(", CxList.CxRegexOptions.None);

The result would be -

Expand source

1 item found:
    foo

Supported from v1.8.1

Returns a CxList which is a subset of this instance and its elements match the specified regular expression string, according to specified Regex Options defined in the parameters(Checkmarx regex options and standard regex options).

This call is equivalent to the following calls and it is recommended to use the short call format by default:

Expand source

public CxList FindByRegex(string expression , CxRegexOptions cxOptions, RegexOptions regularOptions)

A subset of this instance matches the given regular expression according to the additional parameters.

The return value may be empty (Count = 0).

The following code example shows how you can use the FindByRegex method.

This example demonstrates the CxList.FindByRegex() method.

The input source code is:

Expand source

int a = 5;
if (a > 3)
    foo(a)

The source code that uses CxList.FindByRegex method:

Expand source

result = All.FindByRegex(@"(\s)?foo\(", CxList.CxRegexOptions.None, System.Text.RegularExpressions.RegexOptions.None);

The result would be -

Expand source

1 item found:
    foo

Supported from v1.8.1

Returns a CxList which is a subset of this instance and its elements match the specified regular expression string, and fill the extended results parameter with the strings of the matches.

This query search source files with regex, and return the closest same line DOM object to the matches. If no such object exists, returns the closest object in a successive line.

Search does not include searching inside comments and string literals, and regex matches are not allowed to overlap. The matching strings are returned in the extendedResults parameter.

This call is equivalent to the following calls:

Expand source

public CxList FindByRegex(string expression , CxList extendedResults)

A subset of this instance matches the given regular expression according to the additional parameters.

The return value may be empty (Count = 0).

The following code example shows how you can use the FindByRegex method.

This example demonstrates the CxList.FindByRegex() method.

The input source code is:

Expand source

int a = 5;
if (a > 3)
    foo(a);

The source code that uses CxList.FindByRegex method:

Expand source

result = All.FindByRegex(@"(\s)?foo\(", All.NewCxList());

The result would be -

Expand source

1 item found
    foo

Supported from v1.8.1

Returns a CxList which is a subset of this instance and its elements match the specified regular expression string, according to specified flag parameters and fill the extended results parameter with the strings of the matches: The 3 flags are translated to CxRegexOptions enum in the following way (bitmask supported):

Expand source

public CxList FindByRegex(string expression , bool searchInComments, bool searchInStringLiterals, bool recursive, CxList extendedResults)

A subset of this instance matches the given regular expression according to the additional parameters.

The return value may be empty (Count = 0).

The following code example shows how you can use the FindByRegex method.

This example demonstrates the CxList.FindByRegex() method.

The input source code is:

Expand source

int a = 5;
if (a > 3)
    foo(a);

The source code that uses CxList.FindByRegex method:

Expand source

result = All.FindByRegex(@"(\s)?foo\(", false, true, false, All.NewCxList());

The result would be -

Expand source

1 item found
    foo

Supported from v1.8.1

Returns a CxList which is a subset of this instance and its elements match the specified regular expression string, according to specified Checkmarx Regex Options defined in the second parameter, and also fill the extended results parameter with the strings of the matches.

This call is equivalent to the following calls and it is recommended to use the short call format by default:

Expand source

public CxList FindByRegex(string expression , CxRegexOptions cxOptions, CxList extendedResults)

A subset of this instance matches the given regular expression according to the additional parameters.

The return value may be empty (Count = 0).

The following code example shows how you can use the FindByRegex method.

This example demonstrates the CxList.FindByRegex() method.

The input source code is:

Expand source

int a = 5;
if (a > 3)
    foo(a);

The source code that uses CxList.FindByRegex method:

Expand source

result = All.FindByRegex(@"(\s)?foo\(", CxList.CxRegexOptions.None,
All.NewCxList());

The result item would be -

Expand source

1 item found:
    foo

Supported from v1.8.1

Returns a CxList which is a subset of this instance and its elements match the specified regular expression string, according to specified Regex Options defined in the parameters(Checkmarx regex options and standard regex options), and also fill the extended results parameter with the strings of the matches. This call is equivalent to the following call and it is recommended to use the short call format by default: FindByRegex(expression, cxRegexOptions, regexOptions, cxList, 5)

Expand source

public CxList FindByRegex(string expression , CxRegexOptions cxOptions, RegexOptions regularOptions, CxList extendedResults)

A subset of this instance matches the given regular expression according to the additional parameters.

The return value may be empty (Count = 0).

The following code example shows how you can use the FindByRegex method.

This example demonstrates the CxList.FindByRegex() method.

The input source code is:

Expand source

int a = 5;
if (a > 3)
    foo(a);

The source code that uses CxList.FindByRegex method:

Expand source

result = All.FindByRegex(@"(\s)?foo\(", CxList.CxRegexOptions.None,
System.Text.RegularExpressions.RegexOptions.None, All.NewCxList());

The result would be -

Expand source

1 item found:
    foo

Supported from v1.8.1

return DOM objects by searching the source file with regex

None

Find in files by regular expression regardless of DOM and language

None

Find by regular expression in all files of the project regardless of DOM and language.

Expand source

public CxList FindByRegexExt(string pattern)

A list of matches for given regular expression in all project files.

The results are not related to DOM so they can't be compared to DOM objects returned by other functions. Results can't be used as parameters to other queries. The return value may be empty (Count = 0).

This example demonstrate the CxList.FindByRegexExt(string) method.

The input source code is:

Expand source

int a = 5;
if (a > 3)
    foo(a);
else
    FOO(a);
// foo(a)
/* foo */

The source code that uses CxList.FindByRegexExt method:

Expand source

result = All.FindByRegexExt(@"(\s)?foo");

The result would consist of 3 items:

Expand source

foo
// foo
/* foo

Supported from version 7.1.8 and 7.1.6HF5

Find by regular expression in all files of the project regardless of DOM and language.

Expand source

public CxList FindByRegexExt(string expression, string fileMask)

A list of matches for given regular expression in all project files.

The results are not related to DOM so they can't be compared to DOM objects returned by other functions. Results can't be used as parameters to other queries. The return value may be empty (Count = 0).

This example demonstrate the CxList.FindByRegexExt(string, string) method.

The input source code is:

Expand source

int a = 5;
if (a > 3)
    foo(a);
else
FOO(a);
// foo(a)
/* foo */

The source code that uses CxList.FindByRegexExt method:

Expand source

result = All.FindByRegexExt(@"(\s)?foo", “*.cs”);

The search would be only on *.cs files and the result would consist of 3 items:

Expand source

foo
// foo
/* foo

Supported from version 7.1.8 and 7.1.6HF5

Find by regular expression in all files of the project regardless of DOM and language.

Expand source

public CxList FindByRegexExt(string expression, string fileMask, CxRegexOptions cxOptions)

A list of matches for given regular expression in cho

The results are not related to DOM so they can't be compared to DOM objects returned by other functions. Results can't be used as parameters to other queries. The return value may be empty (Count = 0). Default values relevant only from version 7.1.8.

This example demonstrate the CxList.FindByRegexExt(string, string, CxRegexOptions) method.

The input source code is:

Expand source

int a = 5;
if (a > 3)
    foo(a);
else
    FOO(a);
// foo(a)
/* foo */

The source code that uses CxList.FindByRegexExt method:

Expand source

result = All.FindByRegexExt(@"(\s)?foo", "*.*", RegexOptions.IgnoreCase);

The search would be only on *.cs files and the result would consist of 2 items:

Expand source

foo
FOO

Supported from version 7.1.8 and 7.1.6HF5

Find by regular expression in all files of the project regardless of DOM and language.

Expand source

public CxList FindByRegexExt(string expression, string fileMask, bool searchInComments)

A list of matches for given regular expression in chosen project files including or excluding results in comments.

The results are not related to DOM so they can't be compared to DOM objects returned by other functions. Results can't be used as parameters to other queries. The return value may be empty (Count = 0). Default values relevant only from version 7.1.8.

This example demonstrate the CxList.FindByRegexExt(string, string, bool) method.

The input source code is:

Expand source

int a = 5;
if (a > 3)
    foo(a);
else
    FOO(a);
// foo(a)
/* foo */

The source code that uses CxList.FindByRegexExt method:

Expand source

result = All.FindByRegexExt(@"(\s)?foo","*.cs",false);

The result would consist of 3 items:

Expand source

foo
// foo
/* foo

Supported from version 7.1.8 and 7.1.6HF5

Find by regular expression in all files of the project regardless of DOM and language.

Expand source

public CxList FindByRegexExt(string expression, string fileMask = "*.*", CxList.CxRegexOptions cxOptions = CxList.CxRegexOptions.None,
RegexOptions regularOptions = RegexOptions.None)

A list of matches for given regular expression in chosen project files including or excluding results in comments with regex build with specified options.

The results are not related to DOM so they can't be compared to DOM objects returned by other functions. Results can't be used as parameters to other queries. The return value may be empty (Count = 0). Default values relevant only from version 7.1.8.

This example demonstrate the CxList.FindByRegexExt(string, string, CxRegexOptions, RegexOptions) method.

The input source code is:

Expand source

int a = 5;
if (a > 3)
    foo(a);
else
    FOO(a);
// foo(a)
/* foo */

The source code that uses CxList.FindByRegexExt method:

Expand source

result = All.FindByRegexExt(@"(\s)?foo", "*.*", CxRegexOptions.None, RegexOptions.IgnoreCase);

All files in the source code would be searched and the result would consist of 2 items:

Expand source

foo
FOO

Supported from version 7.1.8 and 7.1.6HF5

None

Find by regular expression in all files of the project regardless of DOM and language.

Expand source

public CxList FindByRegexExt(string expression, string fileMask = "*.*", bool searchInComments = true, RegexOptions regularOptions = RegexOptions.None)

A list of matches for given regular expression in chosen project files including or excluding results in comments with regex build with specified options.

The results are not related to DOM so they can't be compared to DOM objects returned by other functions. Results can't be used as parameters to other queries. The return value may be empty (Count = 0). Default values relevant only from version 7.1.8.

This example demonstrate the CxList.FindByRegexExt(string, string, bool, RegexOptions) method.

The input source code is:

Expand source

int a = 5;
if (a > 3)
    foo(a);
else
    FOO(a);
// foo(a)
/* foo */

The source code that uses CxList.FindByRegexExt method:

Expand source

result = All.FindByRegexExt(@"(\s)?foo","*.*","*.json",false,RegexOptions.IgnoreCase);

All files in the source code would be searched except the *.json files and the result would consist of 2 items:

Expand source

foo
FOO

Supported from version 7.1.8 and 7.1.6HF5

Find by regular expression in all files of the project regardless of DOM and language.

Expand source

public CxList FindByRegexExt(string expression, string fileMask = "*.*", bool searchInComments = true,
CxList.CxRegexOptions cxOptions = CxList.CxRegexOptions.None, RegexOptions regularOptions = RegexOptions.None)