Skip to content

Header file includes reorganization #18

Open
@gedankenexperimenter

Description

I want to do a more systematic revision of how header files are included, and apply rules more consistently.

First, there are some headers that Kaleidoglyph ought to export (by some method, but possibly not via Kaleidoglyph.h directly), but which come from the hardware module (e.g. KeyAddr.h). Instead of having any class file that uses the KeyAddr type get it via KALEIDOGLYPH_KEYADDR_H, I want to make a minimal kaleidoglyph/KeyAddr.h file, which would have the following:

#pragma once
#include KALEIDOGLYPH_HARDWARE_H
#include KALEIDOGLYPH_KEYADDR_H

This way, KeyAddr, LedAddr, and Color can be treated just like Key, and plugin code doesn't need to know that those types are special in any way.

Second, I want to go through and carefully apply consistent rules regarding the headers that are included in each file, and the order of inclusion of those headers, starting with the Google C++ style guide, and only deviating from that as necessary.

Metadata

Labels

metaAdministrivia

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions