aboutsummaryrefslogtreecommitdiff
path: root/docs/namespacing.md
blob: 42bdd984fc292e87bb423fdb7a630528631fd1b2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# Namespacing

In order to work with C's namespace limitations, I've designed the following
system, which makes use of a C language extension `-fdollars-in-identifiers`
that lets you use dollar signs in identifiers. This extension is supported by
GCC, TinyCC, and Clang.

## Unique File Suffixes

Each file gets a unique suffix with the format `$<filename>_XXXXXXXX`, where the
Xs are 8 randomly chosen identifier characters and `<filename>` includes only
valid identifier characters up to the first period.

For example, in a file called `hello-world.tm`, a variable like `foo` would
become `foo$helloworld_VEDjfzDs`. This helps avoid namespace conflicts between
two files that define the same symbol.

## Namespaces

Dollar signs in identifiers provide a way to have compiled C code which segments
its imports into different namespaces. For example `Foo$Baz` would be the
identifier `Baz` in the namespace `Foo`, and would be guaranteed to not collide
with a user-chosen name like `FooBaz` or `Foo_Baz`.

## Example

For this Tomo code:

```tomo
// File: foo.tm
my_var := 123

struct Baz(x:Int)
    member := 5
    func frob(b:Baz -> Int)
        return b.x

func main() pass
```

The generated C source code will look like this:

```C
// File: .build/foo.tm.h
...
typedef struct Baz$$struct$foo_VEDjfzDs Baz$$type$foo_VEDjfzDs;
struct Baz$$struct$foo_VEDjfzDs {
    Int_t x;
};
DEFINE_OPTIONAL_TYPE(struct Baz$$struct$foo_VEDjfzDs, 8,$OptionalBaz$$type$foo_VEDjfzDs);
extern const TypeInfo_t Baz$$info$foo_VEDjfzDs;
extern Int_t Baz$member$foo_VEDjfzDs;
Int_t Baz$frob$foo_VEDjfzDs(struct Baz$$struct$foo_VEDjfzDs _$b);
extern Int_t my_var$foo_VEDjfzDs;
void main$foo_VEDjfzDs();
...
```

```C
// File: .build/foo.tm.c
...
public Int_t my_var$foo_VEDjfzDs = I_small(123);
public const TypeInfo_t Baz$$info$foo_VEDjfzDs = {...};
public Int_t Baz$member$foo_VEDjfzDs = I_small(5);

public Int_t Baz$frob$foo_VEDjfzDs(struct Baz$$struct$foo_VEDjfzDs _$b) {
    return (_$b).x;
}

public void main$foo_VEDjfzDs() {
}
...
```