Source files have much in common

ghost commented 3 years ago

Contents of assembler files of firmware and utils directories have much in common (and may be in others, I haven't checked it yet). Some shared source code is in .inc files in utils directory. What if we move all .inc files shared with multiple sources into a separate directory in SDK folder? We may use this directory structure (included files below are just an example of usage):

Variant 1:

sdk
└─include
  ├─rst28.inc
  ├─table.c
  ├─zxuno.def
  └─zxuno.h

Usage:

sjasmplus flags: -I${ZXSDK}/include
Assembler sources:
```
include "zxuno.def"
include "rst28.inc"
```
zcc flags: -I${ZXSDK}/include
C sources:
```
#include "zxuno.h"
#include "table.c"
```

NOTE: In this case there will be a mix of header files (.def, .h) and shared source files (.inc, .c) in one place.

Variant 2:

sdk
├─asm
│ └─rst28.inc
├─c
│ └─table.c
└─include
  ├─zxuno.def
  └─zxuno.h

Usage:

sjasmplus flags: -I${ZXSDK}/include -I${ZXSDK}/asm
Assembler sources:
```
include "zxuno.def"
include "rst28.inc"
```
zcc flags: -I${ZXSDK}/include -I${ZXSDK}/c
C sources:
```
#include "zxuno.h"
#include "table.c"
```

Variant 3:

sdk
└─include
  ├─asm
  │ └─rst28.inc
  ├─c
  │ └─table.c
  ├─zxuno.def
  └─zxuno.h

Usage:

sjasmplus flags: -I${ZXSDK}/include

Assembler sources:

include "zxuno.def"
include "asm/rst28.inc"

zcc flags: -I${ZXSDK}/include
C sources:
```
#include "zxuno.h"
#include "c/table.c"
```

Variant 4:

sdk
├─include
│ ├─zxuno.def
│ └─zxuno.h
└─src
  ├─asm
  │ └─rst28.inc
  └─c
    └─table.c

Usage:

sjasmplus flags: -I${ZXSDK}/include -I${ZXSDK}/src/asm
Assembler sources:
```
include "zxuno.def"
include "rst28.inc"
```
zcc flags: -I${ZXSDK}/include -I${ZXSDK}/src/c
C sources:
```
#include "zxuno.h"
#include "table.c"
```

What do you think?

ghost commented 3 years ago

Is there anyone alive? I think the first variant will be the most suitable, because we don't know the amount of files (so as their role) in include folder.

antoniovillena commented 3 years ago

Ok. Agree with variant 1

ghost commented 3 years ago

Closed by https://github.com/zxdos/zxuno/pull/86

zxdos / zxuno

Source files have much in common #70