Difference between revisions of "Language Reference/Namespaces"

From wiki.visual-prolog.com
m (→‎Open namespaces: formatting)
(One intermediate revision by the same user not shown)
Line 28: Line 28:
Any interface, class and implementation that is meet inside a namespace region belongs to that namespace.
Any interface, class and implementation that is meet inside a namespace region belongs to that namespace.


'''Example'''
{{Example|
 
<vip>class aaa
<vip>class aaa
end class aaa
end class aaa
Line 46: Line 45:


Subsequently, the class <vp>aaa</vp> belongs to the root namespace, the class <vp>bbb</vp> belongs to the namespace <vp>xxx</vp> and finally the class <vp>ccc</vp> belongs to the namespace <vp>xxx\yyy</vp>.
Subsequently, the class <vp>aaa</vp> belongs to the root namespace, the class <vp>bbb</vp> belongs to the namespace <vp>xxx</vp> and finally the class <vp>ccc</vp> belongs to the namespace <vp>xxx\yyy</vp>.
}}


=== Referencing names in namespaces ===
=== Referencing names in namespaces ===
Line 64: Line 64:


<OpenQualification>: one of
<OpenQualification>: one of
     open <NamespaceIdentifier> \
     open <NamespaceIdentifier>\
     ...</vipbnf>
     ...</vipbnf>


Opening a namespace is distinguished from opening a class/interface by a trailing backslash.
Opening a namespace is distinguished from opening a class/interface by a trailing backslash.


'''Example'''
{{Example|
 
<vip>class aaa
<vip>class aaa
     open xxx\yyy\
     open xxx\yyy\
Line 77: Line 76:


The namespace <vp>xxx\yyy</vp> is opened inside <vp>aaa</vp>.
The namespace <vp>xxx\yyy</vp> is opened inside <vp>aaa</vp>.
}}


When a namespace is open that part of a full name can be left out.
When a namespace is open that part of a full name can be left out.


'''Example''' A domains with the full name <vp>\xxx\yyy\zzz\ccc::ddd</vp> can be as referenced <vp>zzz\ccc::ddd</vp> inside <vp>aaa</vp> because <vp>xxx\yyy</vp> is open.
{{Example| A domains with the full name <vp>\xxx\yyy\zzz\ccc::ddd</vp> can be as referenced <vp>zzz\ccc::ddd</vp> inside <vp>aaa</vp> because <vp>xxx\yyy</vp> is open.
}}


Notice that the short name does not start with a backslash; A name starting with a backslash is always a full name.
Notice that the short name does not start with a backslash; A name starting with a backslash is always a full name.


The namespace that a certain scope (i.e. interface/class/implementation) belongs to is (implicitly) open inside that scope.
The namespace that a certain scope (i.e. interface/class/implementation) belongs to is (implicitly) open inside that scope.

Revision as of 11:42, 2 October 2012

Namespaces can be used to avoid name clashes, without having to use long strange names. The names in two different namespaces will never clash, but it may be necessary to qualify references with the namespace (or part of it) to resolve ambiguities.

A namespaces are declared and defined implicitly using NamespaceEntrance'es:

NamespaceEntrance:
   namespace NamespaceIdentifier
NamespaceIdentifier: one of
   LowercaseIdentifier
   LowercaseIdentifier \ NamespaceIdentifier

In short a NamespaceIdentifier is a sequence of lowercase identifiers separated by backslashes.

Namespace Entrances and Regions

Namespace entrances divide source files into namespace regions.

A namespace entrance marks the beginning of a namespace region, which ends at the next namespace entrance or the end of the file.

Every file starts in the root namespace.

Namespace regions are not influenced by #include directives, meaning:

  • Namespace entrances in an #include-file does not change the namespace region in the including file
  • Any file starts in the root namespace (also if it is included inside a namespace region in another file).

Any interface, class and implementation that is meet inside a namespace region belongs to that namespace.

Example
class aaa
end class aaa
 
namespace xxx
 
class bbb
end class bbb
 
namespace xxx\yyy
 
class ccc
end class ccc

This file is divided in three regions (assuming that it is a complete file). The first region is in the root namespace (\), the second region belongs to the xxx namespace and the third region belongs to the xxx\yyy namespace.

Subsequently, the class aaa belongs to the root namespace, the class bbb belongs to the namespace xxx and finally the class ccc belongs to the namespace xxx\yyy.

Referencing names in namespaces

If ccc is a class in the namespace xxx\yyy, then the full name of ccc is \xxx\yyy\ccc.

The leading backslash indicates that we start from the root namespace.

A class/interface can always be uniquely referenced using its full name.

Open namespaces

The full names are not always convenient and therefore it is possible to use shorter names by opening namespaces.

ScopeQualification: one of
    OpenQualification
    ...
 
OpenQualification: one of
    open NamespaceIdentifier\
    ...

Opening a namespace is distinguished from opening a class/interface by a trailing backslash.

Example
class aaa
    open xxx\yyy\
...
end class aaa

The namespace xxx\yyy is opened inside aaa.

When a namespace is open that part of a full name can be left out.

Example A domains with the full name \xxx\yyy\zzz\ccc::ddd can be as referenced zzz\ccc::ddd inside aaa because xxx\yyy is open.

Notice that the short name does not start with a backslash; A name starting with a backslash is always a full name.

The namespace that a certain scope (i.e. interface/class/implementation) belongs to is (implicitly) open inside that scope.