Cpp.ObjectWithPosition Class

Namespace: Cpp

Represents an object that has a known position

Since R2026a

Description

ObjectWithPosition class represents an object that has a position, such as call sites, variables, types, casts, fields, and functions. These objects are represented by classes that inherit from ObjectWithPosition.

The class ObjectWithPosition is a superclass. It cannot interact with your C/C++ code directly. The child classes of this class can invoke the predicates of this class to analyze your C/C++ code.

Predicates

expand all

Types

The predicates in this class uses objects of these types:

Type	Raisable	Printable
`ObjectWithPosition`	Yes	No
`Lang.Int`	No	Yes
`Lang.String`	No	Yes

Syntax

This class defines these predicates. All classes that inherit from this class has access to these predicates. For example, the child class CallSite has access to these predicates and objects of class CallSite can invoke these predicates. Predicates that accept a self object can be invoked on an object using the dot notation. For example, for an object foo of class ObjectWithPosition, the predicate locPath can be invoked as foo.locpath(&path).

Predicate	Description
`locPath(ObjectWithPosition self, Cpp.SourceLoc.Path &path)`	Retrieves the location of the C/C++ source file where the `self` is defined or declared, and assigns the path to the variable `path`.
`extension(ObjectWithPosition self, Lang.String &extension)`	Retrieves the path to the C/C++ source file in which `self` is declared or defined and checks if the extension of the file is `extension`.
`stem(ObjectWithPosition self, Lang.String &stem)`	Retrieves the path to the C/C++ source file in which `self` is declared or defined and checks if the name of the file after excluding the file extension is `stem`.
`path(ObjectWithPosition self, Lang.String &pathString)`	Retrieves the path to the C/C++ source file in which `self` is declared or defined and checks if the string containing the path is `pathString`.
`filename(ObjectWithPosition self, Lang.String &fileNameString)`	Retrieves the path to the C/C++ source file in which `self` is declared or defined and checks if the file name is `fileNameString`.
`line(ObjectWithPosition self, Lang.Int &line)`	From the C/C++ source files at which the object `self` is defined, retrieves the line number and stores the line number in `line`.
`column(ObjectWithPosition self, Lang.Int &column)`	From the C/C++ source files at which the object `self` is defined, retrieves the column number at which the object `self` is defined and stores the column number in `column`.
`isInSameFile(ObjectWithPosition self, ObjectWithPosition obj)`	Retrieves the objects `self` that are defined in the same C/C++ source file as `obj`.
`isBefore(ObjectWithPosition self, ObjectWithPosition obj)`	Retrieves the objects `self` that are defined before the object `obj` in the C/C++ source file.
`isSameLine(ObjectWithPosition self, ObjectWithPosition obj)`	Retrieves the objects `self` that are defined at the same line as the object `obj` in the C/C++ source file.
`linesBetween(ObjectWithPosition self, ObjectWithPosition obj, Lang.Int &nlines)`	Retrieves the number of lines between the objects `self` and `obj` in the C/C++ source file and stores the number in `nlines`

Child Classes

The class ObjectWithpsotion has these child classes.

Child Class	Description
`Cpp.CallSite`	Represents function call sites.
`Cpp.Cast`	Represents casts.
`Cpp.Field`	Represents member variables of starctures, classes, and unions.
`Cpp.Function`	Represents a callable function.
`Cpp.Type`	Represent a built-in or user-defined type.
`Cpp.Variable`	Represents a variable.

Examples

collapse all

Variable Shadowing

In a new folder ObjectWithExample, initialize a new coding standard. At the command line, enter:
```
polyspace-query-language init
```

In the file main.pql, enter this content:

package main

// Main PQL file defines the catalog of your PQL project.
// The catalog is a collection of sections.
catalog ObjectWithpositionExample = {
	#[Description("Example Section")]
	section ExampleSection = {
		#[Description("Local variable shadows global variable"),Id(myRule)]
		rule ExampleRule = {
			defect Exampledefect = 
			when Cpp.Variable.is(&gVar)
			and gVar.isFileStatic()
			and gVar.name(&GlobalName)
			and Cpp.Function.is(&Function)
			and Function.localVariable(&localVar)
			and localVar.name(&LocalName)
			and LocalName == GlobalName
			and localVar.isInSameFile(gVar)
			raise "Local and global share name\"{LocalName}\""
			on localVar

		}
	}
}

Create the coding standard ObjectWithExample.pschk using this command at the command line:
```
polyspace-query-language package
```
Using the generated coding standard, run a Bug Finder anal;ysis on your source file. Foe example, at the command line, enter:
```
polyspace-bug-finder -sources src.cpp -lang cpp -checkers-activation-file ObjectWithExample.pschk
```
The analysis reports the variable shadowing on the local variable named counter.

Version History

Introduced in R2026a