1
0
Fork 0
forked from forks/qmk_firmware

Normalise include statements in core code (#11153)

* Normalise include statements in core code

* Missed one
This commit is contained in:
Ryan 2020-12-11 13:45:24 +11:00 committed by GitHub
parent 5b5d74a267
commit 501f2fdef1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
60 changed files with 99 additions and 79 deletions

View file

@ -29,7 +29,9 @@ This level contains all of the options for that particular keymap. If you wish t
This is a C header file that is one of the first things included, and will persist over the whole project (if included). Lots of variables can be set here and accessed elsewhere. The `config.h` file shouldn't be including other `config.h` files, or anything besides this:
#include "config_common.h"
```c
#include "config_common.h"
```
## Hardware Options

View file

@ -41,7 +41,9 @@ Bevorzugst Du es lieber auf der Befehlszeile zu debuggen? Dafür eignet sich das
Manchmal ist es hilfreich Debug-Nachrichten innerhalb deines eigenen [Custom Codes](de/custom_quantum_functions.md) zu drucken. Das ist ziemlich einfach. Beginne damit `print.h` am Anfang deiner Datei zu inkludieren:
#include <print.h>
```c
#include "print.h"
```
Danach stehen dir verschiedene Druck-Funktionen zur Verfügung:

View file

@ -41,7 +41,9 @@ Para plataformas compatibles, [QMK Toolbox](https://github.com/qmk/qmk_toolbox)
A veces, es útil imprimir mensajes de depuración desde tu [código personalizado](custom_quantum_functions.md). Hacerlo es bastante simple. Comienza incluyendo `print.h` al principio de tu fichero:
#include <print.h>
```c
#include "print.h"
```
Después de eso puedes utilzar algunas funciones print diferentes:

View file

@ -182,7 +182,9 @@ Which would send Left Control+`a` (Left Control down, `a`, Left Control up) - no
By default, it assumes a US keymap with a QWERTY layout; if you want to change that (e.g. if your OS uses software Colemak), include this somewhere in your keymap:
#include <sendstring_colemak.h>
```c
#include "sendstring_colemak.h"
```
### Strings in Memory

View file

@ -184,7 +184,7 @@ If you wanted to consolidate macros and other functions into your userspace for
First, you'd want to go through all of your `keymap.c` files and replace `process_record_user` with `process_record_keymap` instead. This way, you can still use keyboard specific codes on those boards, and use your custom "global" keycodes as well. You'll also want to replace `SAFE_RANGE` with `NEW_SAFE_RANGE` so that you wont have any overlapping keycodes
Then add `#include <name.h>` to all of your keymap.c files. This allows you to use these new keycodes without having to redefine them in each keymap.
Then add `#include "<name>.h"` to all of your keymap.c files. This allows you to use these new keycodes without having to redefine them in each keymap.
Once you've done that, you'll want to set the keycode definitions that you need to the `<name>.h` file. For instance:
```c

View file

@ -42,7 +42,9 @@ Vous préférez une solution basée sur le terminal? [hid_listen](https://www.pj
Parfois, il est utile d'afficher des messages de débugage depuis votre [code custom](custom_quantum_functions.md). Le faire est assez simple. Commencez par ajouter `print.h` au début de votre fichier:
#include <print.h>
```c
#include "print.h"
```
Une fois fait, vous pouvez utiliser les fonctions print suivantes:

View file

@ -34,7 +34,9 @@ QMK での全ての利用可能な設定にはデフォルトがあります。
これは最初に include されるものの 1 つである C ヘッダファイルで、プロジェクト全体(もし含まれる場合)にわたって持続します。多くの変数をここで設定し、他の場所からアクセスすることができます。`config.h` ファイルでは、以下のもの以外の、他の `config.h` ファイルやその他のファイルの include をしないでください:
#include "config_common.h"
```c
#include "config_common.h"
```
## ハードウェアオプション

View file

@ -187,7 +187,9 @@ void post_process_record_user(uint16_t keycode, keyrecord_t *record) {
デフォルトでは、QWERTY レイアウトの US キーマップを想定しています; それを変更したい場合(例えば OS がソフトウェア Colemak を使う場合)、キーマップのどこかに以下を含めます:
#include <sendstring_colemak.h>
```c
#include "sendstring_colemak.h"
```
### メモリ内の文字列

View file

@ -189,7 +189,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
最初に、全ての `keymap.c` ファイルを調べ、代わりに `process_record_user``process_record_keymap` に置き換えます。この方法では、これらのキーボードでキーボード固有のコードを使用でき、カスタムの "global" キーコードも使うことができます。また、`SAFE_RANGE` を `NEW_SAFE_RANGE` に置き換えて、キーコードが重複しないようにすることもできます。
次に、全ての keymap.c ファイルに `#include <name.h>` を追加します。これにより、各キーマップでそれらを再定義することなく新しいキーコードを使うことができます。
次に、全ての keymap.c ファイルに `#include "<name>.h"` を追加します。これにより、各キーマップでそれらを再定義することなく新しいキーコードを使うことができます。
それが完了したら、必要なキーコードの定義を `<name>.h` ファイルに設定します。例えば:
```c

View file

@ -45,7 +45,9 @@ void keyboard_post_init_user(void) {
[custom code](ja/custom_quantum_functions.md)内からデバッグメッセージを出力すると便利な場合があります。それはとても簡単です。ファイルの先頭に`print.h`のインクルードを追加します:
#include <print.h>
```c
#include "print.h"
```
そのあとは、いくつかの異なった print 関数を使用することが出来ます。

View file

@ -36,7 +36,9 @@ Prefer a terminal based solution? [hid_listen](https://www.pjrc.com/teensy/hid_l
Sometimes it's useful to print debug messages from within your [custom code](custom_quantum_functions.md). Doing so is pretty simple. Start by including `print.h` at the top of your file:
#include <print.h>
```c
#include "print.h"
```
After that you can use a few different print functions:

View file

@ -34,7 +34,9 @@ void keyboard_post_init_user(void) {
有时用[custom code](custom_quantum_functions.md)发送自定义调试信息很有用. 这么做很简单. 首先在你文件头部包含`print.h`:
#include <print.h>
```c
#include "print.h"
```
之后,您可以使用一些不同的打印功能:

View file

@ -16,7 +16,7 @@
#include "quantum.h"
#include "analog.h"
#include "ch.h"
#include <ch.h>
#include <hal.h>
#if !HAL_USE_ADC

View file

@ -24,7 +24,7 @@
*/
#pragma once
#include "ch.h"
#include <ch.h>
#include <hal.h>
#ifdef I2C1_BANK

View file

@ -6,7 +6,7 @@
#include "serial.h"
#include "wait.h"
#include "hal.h"
#include <hal.h>
// TODO: resolve/remove build warnings
#if defined(RGBLIGHT_ENABLE) && defined(RGBLED_SPLIT) && defined(PROTOCOL_CHIBIOS) && defined(WS2812_DRIVER_BITBANG)

View file

@ -2,8 +2,8 @@
#include "serial.h"
#include "printf.h"
#include "ch.h"
#include "hal.h"
#include <ch.h>
#include <hal.h>
#ifndef USART_CR1_M0
# define USART_CR1_M0 USART_CR1_M // some platforms (f1xx) dont have this so

View file

@ -18,7 +18,7 @@
#include <ch.h>
#include <hal.h>
#include <quantum.h>
#include "quantum.h"
#ifndef SPI_DRIVER
# define SPI_DRIVER SPID2

View file

@ -1,7 +1,7 @@
#include "quantum.h"
#include "ws2812.h"
#include "ch.h"
#include "hal.h"
#include <ch.h>
#include <hal.h>
/* Adapted from https://github.com/bigjosh/SimpleNeoPixelDemo/ */

View file

@ -1,6 +1,6 @@
#include "ws2812.h"
#include "quantum.h"
#include "hal.h"
#include <hal.h>
/* Adapted from https://github.com/joewa/WS2812-LED-Driver_ChibiOS/ */

View file

@ -17,7 +17,7 @@
#include <stdint.h>
#include <string.h>
#include "hal.h"
#include <hal.h>
#include "eeprom_driver.h"
#include "eeprom_stm32_L0_L1.h"

View file

@ -15,7 +15,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <timer.h>
#include "timer.h"
#include "solenoid.h"
#include "haptic.h"

View file

@ -28,7 +28,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "micro_oled.h"
#include <print.h>
#include "print.h"
#include <stdlib.h>
#include "util/font5x7.h"
#include "util/font8x16.h"

View file

@ -19,8 +19,8 @@
* generator plugin. Do not edit manually.
*/
#include "hal.h"
#include "stm32_gpio.h"
#include <hal.h>
#include <stm32_gpio.h>
/*===========================================================================*/
/* Driver local definitions. */

View file

@ -13,7 +13,7 @@
See the License for the specific language governing permissions and
limitations under the License.
*/
#include "hal.h"
#include <hal.h>
#if HAL_USE_PAL || defined(__DOXYGEN__)
/**

View file

@ -14,7 +14,7 @@
limitations under the License.
*/
#include "hal.h"
#include <hal.h>
// Value to place in RTC backup register 10 for persistent bootloader mode
#define RTC_BOOTLOADER_FLAG 0x424C

View file

@ -15,8 +15,8 @@
*/
#include "audio.h"
#include "ch.h"
#include "hal.h"
#include <ch.h>
#include <hal.h>
#include <string.h>
#include "print.h"

View file

@ -19,8 +19,8 @@
# include <avr/interrupt.h>
# include <avr/pgmspace.h>
#else
# include "ch.h"
# include "hal.h"
# include <ch.h>
# include <hal.h>
#endif
#ifndef LUTS_H

View file

@ -15,10 +15,10 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include <avr/interrupt.h>
#include <avr/io.h>
#include <timer.h>
#include <fauxclicky.h>
#include "timer.h"
#include "fauxclicky.h"
#include <stdbool.h>
#include <musical_notes.h>
#include "musical_notes.h"
bool fauxclicky_enabled = true;
uint16_t note_start = 0;

View file

@ -18,7 +18,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#endif
#include "musical_notes.h"
#include "stdbool.h"
#include <stdbool.h>
__attribute__((weak)) float fauxclicky_pressed_note[2] = MUSICAL_NOTE(_D4, 0.25);
__attribute__((weak)) float fauxclicky_released_note[2] = MUSICAL_NOTE(_C4, 0.125);

View file

@ -25,7 +25,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
# include <avr/pgmspace.h>
#elif defined PROTOCOL_CHIBIOS
// We need to ensure that chibios is include before redefining reset
# include "ch.h"
# include <ch.h>
#endif
#include "keycode.h"
#include "action_macro.h"

View file

@ -14,8 +14,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "inttypes.h"
#include "stdint.h"
#include <inttypes.h>
#include <stdint.h>
#include "process_key_lock.h"
#define BV_64(shift) (((uint64_t)1) << (shift))

View file

@ -21,7 +21,7 @@
# include <avr/interrupt.h>
#endif
#if defined(PROTOCOL_CHIBIOS)
# include "hal.h"
# include <hal.h>
# include "chibios_config.h"
#endif

View file

@ -23,7 +23,7 @@
#include <string.h>
#include <math.h>
#include "lib/lib8tion/lib8tion.h"
#include <lib/lib8tion/lib8tion.h>
#ifndef RGB_MATRIX_CENTER
const point_t k_rgb_matrix_center = {112, 32};

View file

@ -24,7 +24,7 @@
# include "eeprom.h"
#endif
#ifdef STM32_EEPROM_ENABLE
# include "hal.h"
# include <hal.h>
# include "eeprom_stm32.h"
#endif
#include "wait.h"
@ -34,7 +34,7 @@
#include "color.h"
#include "debug.h"
#include "led_tables.h"
#include "lib/lib8tion/lib8tion.h"
#include <lib/lib8tion/lib8tion.h>
#ifdef VELOCIKEY_ENABLE
# include "velocikey.h"
#endif
@ -983,7 +983,7 @@ void rgblight_task(void) {
# ifndef RGBLIGHT_BREATHE_TABLE_SIZE
# define RGBLIGHT_BREATHE_TABLE_SIZE 256 // 256 or 128 or 64
# endif
# include <rgblight_breathe_table.h>
# include "rgblight_breathe_table.h"
# endif
__attribute__((weak)) const uint8_t RGBLED_BREATHING_INTERVALS[] PROGMEM = {30, 20, 10, 5};

View file

@ -24,7 +24,7 @@ SOFTWARE.
#include "report.h"
#include "host_driver.h"
#include "serial_link/system/serial_link.h"
#include "hal.h"
#include <hal.h>
#include "serial_link/protocol/byte_stuffer.h"
#include "serial_link/protocol/transport.h"
#include "serial_link/protocol/frame_router.h"

View file

@ -36,7 +36,7 @@ host_driver_t* get_serial_link_driver(void);
void serial_link_update(void);
#if defined(PROTOCOL_CHIBIOS)
# include "ch.h"
# include <ch.h>
static inline void serial_link_lock(void) { chSysLock(); }

View file

@ -12,7 +12,7 @@
#endif
#ifdef PROTOCOL_VUSB
# include "usbdrv.h"
# include <usbdrv/usbdrv.h>
#endif
#ifdef EE_HANDS

View file

@ -1,6 +1,6 @@
#pragma once
#include <common/matrix.h>
#include "common/matrix.h"
void transport_master_init(void);
void transport_slave_init(void);

View file

@ -16,7 +16,7 @@
#pragma once
#include <tmk_core/common/eeconfig.h> // for EECONFIG_SIZE
#include "tmk_core/common/eeconfig.h" // for EECONFIG_SIZE
// Keyboard level code can change where VIA stores the magic.
// The magic is the build date YYMMDD encoded as BCD in 3 bytes,

View file

@ -24,7 +24,7 @@ SOFTWARE.
#ifndef LCD_BACKLIGHT_H_
#define LCD_BACKLIGHT_H_
#include "stdint.h"
#include <stdint.h>
// Helper macros for storing hue, staturation and intensity as unsigned integers
#define LCD_COLOR(hue, saturation, intensity) (hue << 16 | saturation << 8 | intensity)

View file

@ -22,7 +22,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#include "gfx.h"
#include "math.h"
#include <math.h>
#include "led_backlight_keyframes.h"
static uint8_t fade_led_color(keyframe_animation_t* animation, int from, int to) {

View file

@ -26,7 +26,7 @@ SOFTWARE.
#include "visualizer.h"
#include <string.h>
#ifdef PROTOCOL_CHIBIOS
# include "ch.h"
# include <ch.h>
#endif
#include "gfx.h"

View file

@ -48,7 +48,7 @@ int retro_tapping_counter = 0;
#endif
#ifdef FAUXCLICKY_ENABLE
# include <fauxclicky.h>
# include "fauxclicky.h"
#endif
#ifdef IGNORE_MOD_TAP_INTERRUPT_PER_KEY

View file

@ -1,7 +1,7 @@
#include "bootloader.h"
#include "ch.h"
#include "hal.h"
#include <ch.h>
#include <hal.h>
#include "wait.h"
/* This code should be checked whether it runs correctly on platforms */

View file

@ -24,8 +24,8 @@
#ifndef __EEPROM_H
#define __EEPROM_H
#include "ch.h"
#include "hal.h"
#include <ch.h>
#include <hal.h>
#include "flash_stm32.h"
// HACK ALERT. This definition may not match your processor

View file

@ -1,5 +1,5 @@
#include "ch.h"
#include "hal.h"
#include <ch.h>
#include <hal.h>
#include "eeconfig.h"

View file

@ -23,8 +23,8 @@
extern "C" {
#endif
#include "ch.h"
#include "hal.h"
#include <ch.h>
#include <hal.h>
typedef enum { FLASH_BUSY = 1, FLASH_ERROR_PG, FLASH_ERROR_WRP, FLASH_ERROR_OPT, FLASH_COMPLETE, FLASH_TIMEOUT, FLASH_BAD_ADDRESS } FLASH_Status;

View file

@ -1,5 +1,5 @@
#include "ch.h"
#include "hal.h"
#include <ch.h>
#include <hal.h>
#include "led.h"
#include "sleep_led.h"

View file

@ -1,7 +1,7 @@
/* TODO */
#include "ch.h"
#include "hal.h"
#include <ch.h>
#include <hal.h>
#include "matrix.h"
#include "action.h"

View file

@ -1,4 +1,4 @@
#include "ch.h"
#include <ch.h>
#include "timer.h"

View file

@ -5,7 +5,7 @@
#include "action_layer.h"
#ifdef STM32_EEPROM_ENABLE
# include "hal.h"
# include <hal.h>
# include "eeprom_stm32.h"
#endif

View file

@ -12,7 +12,7 @@ extern "C" {
# define wait_ms(ms) _delay_ms(ms)
# define wait_us(us) _delay_us(us)
#elif defined PROTOCOL_CHIBIOS
# include "ch.h"
# include <ch.h>
# define wait_ms(ms) \
do { \
if (ms != 0) { \

View file

@ -15,8 +15,8 @@
* GPL v2 or later.
*/
#include "ch.h"
#include "hal.h"
#include <ch.h>
#include <hal.h>
#include "usb_main.h"

View file

@ -22,7 +22,7 @@
* @{
*/
#include "hal.h"
#include <hal.h>
#include "usb_driver.h"
#include <string.h>

View file

@ -25,7 +25,7 @@
#ifndef USB_DRIVER_H
# define USB_DRIVER_H
# include "hal_usb_cdc.h"
# include <hal_usb_cdc.h>
/*===========================================================================*/
/* Driver constants. */

View file

@ -25,8 +25,8 @@
* makes the assumption this is safe to avoid littering with preprocessor directives.
*/
#include "ch.h"
#include "hal.h"
#include <ch.h>
#include <hal.h>
#include "usb_main.h"

View file

@ -21,8 +21,8 @@
// TESTING
// extern uint8_t blinkLed;
#include "ch.h"
#include "hal.h"
#include <ch.h>
#include <hal.h>
/* -------------------------
* General USB driver header

View file

@ -61,7 +61,7 @@ extern keymap_config_t keymap_config;
#endif
#ifdef AUDIO_ENABLE
# include <audio.h>
# include "audio.h"
#endif
#ifdef BLUETOOTH_ENABLE

View file

@ -32,7 +32,7 @@ interrupt_setting_t store_and_clear_interrupt(void) {
void restore_interrupt_setting(interrupt_setting_t setting) { SREG = setting; }
#elif defined(__arm__)
# include "ch.h"
# include <ch.h>
interrupt_setting_t store_and_clear_interrupt(void) {
chSysLock();

View file

@ -46,7 +46,7 @@
#include <LUFA/Drivers/USB/USB.h>
#ifdef PROTOCOL_CHIBIOS
# include "hal.h"
# include <hal.h>
#endif
/*