qmk-keychron-q3-colemak-dh/keyboards/choc_taro/choc_taro.h

/* Copyright 2020 kakunpc
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include "quantum.h"

/* This is a shortcut to help you visually see your layout.
 *
 * The first section contains all of the arguments representing the physical
 * layout of the board and position of the keys.
 *
 * The second converts the arguments into a two-dimensional array which
 * represents the switch matrix.
 */

/* LAYOUT_all
 * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┐
 * │001│002│003│004│005│006│007│008│009│010│011│012│013│014│015│
 * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┤
 * │101  │102│103│104│105│106│107│108│109│110│111│112│113│114  │
 * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
 * │201   │202│203│204│205│206│207│208│209│210│211│212│213     │
 * ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────┬───┤
 * │301 │301│302│303│304│305│306│307│308│309│310│311│312   │313│
 * ├────┼───┴┬──┴─┬─┴───┴──┬┴───┼───┴───┴──┬┴──┬┴──┬┴──┬───┴───┤
 * │▓▓▓▓│401 │402 │403     │404 │405       │406│407│408│▓▓▓▓▓▓▓│
 * └────┴────┴────┴────────┴────┴──────────┴───┴───┴───┴───────┘
*/
#define LAYOUT_all( \
    k001, k002, k003, k004, k005, k006, k007, k008, k009, k010, k011, k012, k013, k014, k015,  \
    k101, k102, k103, k104, k105, k106, k107, k108, k109, k110, k111, k112, k113, k114,  \
    k201, k202, k203, k204, k205, k206, k207, k208, k209, k210, k211, k212, k213,  \
    k301, k302, k303, k304, k305, k306, k307, k308, k309, k310, k311, k312, k313,  \
    k401, k402, k403, k404, k405, k406, k407, k408 \
) \
{ \
    { k009, k109, k209, k309, KC_NO } , \
    { k010, k110, k210, k310, KC_NO } , \
    { k011, k111, k211, k311, KC_NO } , \
    { k012, k112, k212, k312, KC_NO } , \
    { k013, k113, k213, k313, KC_NO } , \
    { k014, k114, KC_NO, KC_NO, KC_NO } , \
    { k015, KC_NO, KC_NO, KC_NO, KC_NO } ,  \
    { KC_NO, KC_NO, KC_NO, KC_NO, KC_NO } ,  \
    { k001, k101, k201, k301, k401 } , \
    { k002, k102, k202, k302, k402 } , \
    { k003, k103, k203, k303, k403 } , \
    { k004, k104, k204, k304, k404 } , \
    { k005, k105, k205, k305, k405 } , \
    { k006, k106, k206, k306, k406 } , \
    { k007, k107, k207, k307, k407 } , \
    { k008, k108, k208, k308, k408 }  \
}

/* LAYOUT_ansi
 * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
 * │001│002│003│004│005│006│007│008│009│010│011│012│013│  014  │
 * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
 * │101  │102│103│104│105│106│107│108│109│110│111│112│113│114  │
 * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
 * │201   │202│203│204│205│206│207│208│209│210│211│212│213     │
 * ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────────┤
 * │301 │301│302│303│304│305│306│307│308│309│310│311│  312     │
 * ├────┼───┴┬──┴─┬─┴───┴──┬┴───┼───┴───┴──┬┴──┬┴──┬┴──┬───────┤
 * │▓▓▓▓│401 │402 │403     │404 │405       │406│407│408│▓▓▓▓▓▓▓│
 * └────┴────┴────┴────────┴────┴──────────┴───┴───┴───┴───────┘
*/
#define LAYOUT_ansi( \
    k001, k002, k003, k004, k005, k006, k007, k008, k009, k010, k011, k012, k013, k014, \
    k101, k102, k103, k104, k105, k106, k107, k108, k109, k110, k111, k112, k113, k114,  \
    k201, k202, k203, k204, k205, k206, k207, k208, k209, k210, k211, k212, k213,  \
    k301, k302, k303, k304, k305, k306, k307, k308, k309, k310, k311, k312, \
    k401, k402, k403, k404, k405, k406, k407, k408 \
) \
{ \
    { k009, k109, k209, k309, KC_NO } , \
    { k010, k110, k210, k310, KC_NO } , \
    { k011, k111, k211, k311, KC_NO } , \
    { k012, k112, k212, k312, KC_NO } , \
    { k013, k113, k213, KC_NO, KC_NO } , \
    { k014, k114, KC_NO, KC_NO, KC_NO } , \
    { KC_NO, KC_NO, KC_NO, KC_NO, KC_NO } ,  \
    { KC_NO, KC_NO, KC_NO, KC_NO, KC_NO } ,  \
    { k001, k101, k201, k301, k401 } , \
    { k002, k102, k202, k302, k402 } , \
    { k003, k103, k203, k303, k403 } , \
    { k004, k104, k204, k304, k404 } , \
    { k005, k105, k205, k305, k405 } , \
    { k006, k106, k206, k306, k406 } , \
    { k007, k107, k207, k307, k407 } , \
    { k008, k108, k208, k308, k408 }  \
}

/* LAYOUT_ansi_split_bs
 * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┐
 * │001│002│003│004│005│006│007│008│009│010│011│012│013│014│015│
 * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┤
 * │101  │102│103│104│105│106│107│108│109│110│111│112│113│114  │
 * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
 * │201   │202│203│204│205│206│207│208│209│210│211│212│213     │
 * ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────────┤
 * │301 │301│302│303│304│305│306│307│308│309│310│311│  312     │
 * ├────┼───┴┬──┴─┬─┴───┴──┬┴───┼───┴───┴──┬┴──┬┴──┬┴──┬───────┤
 * │▓▓▓▓│401 │402 │403     │404 │405       │406│407│408│▓▓▓▓▓▓▓│
 * └────┴────┴────┴────────┴────┴──────────┴───┴───┴───┴───────┘
*/
#define LAYOUT_ansi_split_bs( \
    k001, k002, k003, k004, k005, k006, k007, k008, k009, k010, k011, k012, k013, k014, k015,  \
    k101, k102, k103, k104, k105, k106, k107, k108, k109, k110, k111, k112, k113, k114,  \
    k201, k202, k203, k204, k205, k206, k207, k208, k209, k210, k211, k212, k213,  \
    k301, k302, k303, k304, k305, k306, k307, k308, k309, k310, k311, k312,  \
    k401, k402, k403, k404, k405, k406, k407, k408 \
) \
{ \
    { k009, k109, k209, k309, KC_NO } , \
    { k010, k110, k210, k310, KC_NO } , \
    { k011, k111, k211, k311, KC_NO } , \
    { k012, k112, k212, k312, KC_NO } , \
    { k013, k113, k213, KC_NO, KC_NO } , \
    { k014, k114, KC_NO, KC_NO, KC_NO } , \
    { k015, KC_NO, KC_NO, KC_NO, KC_NO } ,  \
    { KC_NO, KC_NO, KC_NO, KC_NO, KC_NO } ,  \
    { k001, k101, k201, k301, k401 } , \
    { k002, k102, k202, k302, k402 } , \
    { k003, k103, k203, k303, k403 } , \
    { k004, k104, k204, k304, k404 } , \
    { k005, k105, k205, k305, k405 } , \
    { k006, k106, k206, k306, k406 } , \
    { k007, k107, k207, k307, k407 } , \
    { k008, k108, k208, k308, k408 }  \
}


/* LAYOUT_ansi_split_rshift
 * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
 * │001│002│003│004│005│006│007│008│009│010│011│012│013│  014  │
 * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
 * │101  │102│103│104│105│106│107│108│109│110│111│112│113│114  │
 * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
 * │201   │202│203│204│205│206│207│208│209│210│211│212│213     │
 * ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────┬───┤
 * │301 │301│302│303│304│305│306│307│308│309│310│311│312   │313│
 * ├────┼───┴┬──┴─┬─┴───┴──┬┴───┼───┴───┴──┬┴──┬┴──┬┴──┬───┴───┤
 * │▓▓▓▓│401 │402 │403     │404 │405       │406│407│408│▓▓▓▓▓▓▓│
 * └────┴────┴────┴────────┴────┴──────────┴───┴───┴───┴───────┘
*/
#define LAYOUT_ansi_split_rshift( \
    k001, k002, k003, k004, k005, k006, k007, k008, k009, k010, k011, k012, k013, k014,  \
    k101, k102, k103, k104, k105, k106, k107, k108, k109, k110, k111, k112, k113, k114,  \
    k201, k202, k203, k204, k205, k206, k207, k208, k209, k210, k211, k212, k213,  \
    k301, k302, k303, k304, k305, k306, k307, k308, k309, k310, k311, k312, k313,  \
    k401, k402, k403, k404, k405, k406, k407, k408 \
) \
{ \
    { k009, k109, k209, k309, KC_NO } , \
    { k010, k110, k210, k310, KC_NO } , \
    { k011, k111, k211, k311, KC_NO } , \
    { k012, k112, k212, k312, KC_NO } , \
    { k013, k113, k213, k313, KC_NO } , \
    { k014, k114, KC_NO, KC_NO, KC_NO } , \
    { KC_NO, KC_NO, KC_NO, KC_NO, KC_NO } ,  \
    { KC_NO, KC_NO, KC_NO, KC_NO, KC_NO } ,  \
    { k001, k101, k201, k301, k401 } , \
    { k002, k102, k202, k302, k402 } , \
    { k003, k103, k203, k303, k403 } , \
    { k004, k104, k204, k304, k404 } , \
    { k005, k105, k205, k305, k405 } , \
    { k006, k106, k206, k306, k406 } , \
    { k007, k107, k207, k307, k407 } , \
    { k008, k108, k208, k308, k408 }  \
}


/* LAYOUT_iso
 * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
 * │001│002│003│004│005│006│007│008│009│010│011│012│013│  014  │
 * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
 * │101  │102│103│104│105│106│107│108│109│110│111│112│113│     │
 * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┐114 │
 * │201   │202│203│204│205│206│207│208│209│210│211│212│213│    │
 * ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴────┤
 * │301 │301│302│303│304│305│306│307│308│309│310│311│  312     │
 * ├────┼───┴┬──┴─┬─┴───┴──┬┴───┼───┴───┴──┬┴──┬┴──┬┴──┬───────┤
 * │▓▓▓▓│401 │402 │403     │404 │405       │406│407│408│▓▓▓▓▓▓▓│
 * └────┴────┴────┴────────┴────┴──────────┴───┴───┴───┴───────┘
*/
#define LAYOUT_iso( \
    k001, k002, k003, k004, k005, k006, k007, k008, k009, k010, k011, k012, k013, k014,  \
    k101, k102, k103, k104, k105, k106, k107, k108, k109, k110, k111, k112, k113, k114,  \
    k201, k202, k203, k204, k205, k206, k207, k208, k209, k210, k211, k212, k213,  \
    k301, k302, k303, k304, k305, k306, k307, k308, k309, k310, k311, k312,  \
    k401, k402, k403, k404, k405, k406, k407, k408 \
) \
{ \
    { k009, k109, k209, k309, KC_NO } , \
    { k010, k110, k210, k310, KC_NO } , \
    { k011, k111, k211, k311, KC_NO } , \
    { k012, k112, k212, k312, KC_NO } , \
    { k013, k113, k213, KC_NO, KC_NO } , \
    { k014, k114, KC_NO, KC_NO, KC_NO } , \
    { KC_NO, KC_NO, KC_NO, KC_NO, KC_NO } ,  \
    { KC_NO, KC_NO, KC_NO, KC_NO, KC_NO } ,  \
    { k001, k101, k201, k301, k401 } , \
    { k002, k102, k202, k302, k402 } , \
    { k003, k103, k203, k303, k403 } , \
    { k004, k104, k204, k304, k404 } , \
    { k005, k105, k205, k305, k405 } , \
    { k006, k106, k206, k306, k406 } , \
    { k007, k107, k207, k307, k407 } , \
    { k008, k108, k208, k308, k408 }  \
}

/* LAYOUT_iso_split_rshift
 * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
 * │001│002│003│004│005│006│007│008│009│010│011│012│013│  014  │
 * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
 * │101  │102│103│104│105│106│107│108│109│110│111│112│113│     │
 * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┐114 │
 * │201   │202│203│204│205│206│207│208│209│210│211│212│213│    │
 * ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴┬───┤
 * │301 │301│302│303│304│305│306│307│308│309│310│311│312   │313│
 * ├────┼───┴┬──┴─┬─┴───┴──┬┴───┼───┴───┴──┬┴──┬┴──┬┴──┬───┴───┤
 * │▓▓▓▓│401 │402 │403     │404 │405       │406│407│408│▓▓▓▓▓▓▓│
 * └────┴────┴────┴────────┴────┴──────────┴───┴───┴───┴───────┘
*/
#define LAYOUT_iso_split_rshift( \
    k001, k002, k003, k004, k005, k006, k007, k008, k009, k010, k011, k012, k013, k014,  \
    k101, k102, k103, k104, k105, k106, k107, k108, k109, k110, k111, k112, k113, k114,  \
    k201, k202, k203, k204, k205, k206, k207, k208, k209, k210, k211, k212, k213,  \
    k301, k302, k303, k304, k305, k306, k307, k308, k309, k310, k311, k312, k313,  \
    k401, k402, k403, k404, k405, k406, k407, k408 \
) \
{ \
    { k009, k109, k209, k309, KC_NO } , \
    { k010, k110, k210, k310, KC_NO } , \
    { k011, k111, k211, k311, KC_NO } , \
    { k012, k112, k212, k312, KC_NO } , \
    { k013, k113, k213, k313, KC_NO } , \
    { k014, k114, KC_NO, KC_NO, KC_NO } , \
    { KC_NO, KC_NO, KC_NO, KC_NO, KC_NO } ,  \
    { KC_NO, KC_NO, KC_NO, KC_NO, KC_NO } ,  \
    { k001, k101, k201, k301, k401 } , \
    { k002, k102, k202, k302, k402 } , \
    { k003, k103, k203, k303, k403 } , \
    { k004, k104, k204, k304, k404 } , \
    { k005, k105, k205, k305, k405 } , \
    { k006, k106, k206, k306, k406 } , \
    { k007, k107, k207, k307, k407 } , \
    { k008, k108, k208, k308, k408 }  \
}

/* LAYOUT_iso_split_bs
 * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┐
 * │001│002│003│004│005│006│007│008│009│010│011│012│013│014│015│
 * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┤
 * │101  │102│103│104│105│106│107│108│109│110│111│112│113│     │
 * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┐114 │
 * │201   │202│203│204│205│206│207│208│209│210│211│212│213│    │
 * ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴────┤
 * │301 │301│302│303│304│305│306│307│308│309│310│311│  312     │
 * ├────┼───┴┬──┴─┬─┴───┴──┬┴───┼───┴───┴──┬┴──┬┴──┬┴──┬───────┤
 * │▓▓▓▓│401 │402 │403     │404 │405       │406│407│408│▓▓▓▓▓▓▓│
 * └────┴────┴────┴────────┴────┴──────────┴───┴───┴───┴───────┘
*/
#define LAYOUT_iso_split_bs( \
    k001, k002, k003, k004, k005, k006, k007, k008, k009, k010, k011, k012, k013, k014, k015,  \
    k101, k102, k103, k104, k105, k106, k107, k108, k109, k110, k111, k112, k113, k114,  \
    k201, k202, k203, k204, k205, k206, k207, k208, k209, k210, k211, k212, k213,  \
    k301, k302, k303, k304, k305, k306, k307, k308, k309, k310, k311, k312,  \
    k401, k402, k403, k404, k405, k406, k407, k408 \
) \
{ \
    { k009, k109, k209, k309, KC_NO } , \
    { k010, k110, k210, k310, KC_NO } , \
    { k011, k111, k211, k311, KC_NO } , \
    { k012, k112, k212, k312, KC_NO } , \
    { k013, k113, k213, KC_NO, KC_NO } , \
    { k014, k114, KC_NO, KC_NO, KC_NO } , \
    { k015, KC_NO, KC_NO, KC_NO, KC_NO } ,  \
    { KC_NO, KC_NO, KC_NO, KC_NO, KC_NO } ,  \
    { k001, k101, k201, k301, k401 } , \
    { k002, k102, k202, k302, k402 } , \
    { k003, k103, k203, k303, k403 } , \
    { k004, k104, k204, k304, k404 } , \
    { k005, k105, k205, k305, k405 } , \
    { k006, k106, k206, k306, k406 } , \
    { k007, k107, k207, k307, k407 } , \
    { k008, k108, k208, k308, k408 }  \
}

/* LAYOUT_iso_split_bs_rshift
 * ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┐
 * │001│002│003│004│005│006│007│008│009│010│011│012│013│014│015│
 * ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┤
 * │101  │102│103│104│105│106│107│108│109│110│111│112│113│     │
 * ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┐114 │
 * │201   │202│203│204│205│206│207│208│209│210│211│212│213│    │
 * ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴┬───┤
 * │301 │301│302│303│304│305│306│307│308│309│310│311│312   │313│
 * ├────┼───┴┬──┴─┬─┴───┴──┬┴───┼───┴───┴──┬┴──┬┴──┬┴──┬───┴───┤
 * │▓▓▓▓│401 │402 │403     │404 │405       │406│407│408│▓▓▓▓▓▓▓│
 * └────┴────┴────┴────────┴────┴──────────┴───┴───┴───┴───────┘
*/
#define LAYOUT_iso_split_bs_rshift( \
    k001, k002, k003, k004, k005, k006, k007, k008, k009, k010, k011, k012, k013, k014, k015,  \
    k101, k102, k103, k104, k105, k106, k107, k108, k109, k110, k111, k112, k113, k114,  \
    k201, k202, k203, k204, k205, k206, k207, k208, k209, k210, k211, k212, k213,  \
    k301, k302, k303, k304, k305, k306, k307, k308, k309, k310, k311, k312, k313,  \
    k401, k402, k403, k404, k405, k406, k407, k408 \
) \
{ \
    { k009, k109, k209, k309, KC_NO } , \
    { k010, k110, k210, k310, KC_NO } , \
    { k011, k111, k211, k311, KC_NO } , \
    { k012, k112, k212, k312, KC_NO } , \
    { k013, k113, k213, k313, KC_NO } , \
    { k014, k114, KC_NO, KC_NO, KC_NO } , \
    { k015, KC_NO, KC_NO, KC_NO, KC_NO } ,  \
    { KC_NO, KC_NO, KC_NO, KC_NO, KC_NO } ,  \
    { k001, k101, k201, k301, k401 } , \
    { k002, k102, k202, k302, k402 } , \
    { k003, k103, k203, k303, k403 } , \
    { k004, k104, k204, k304, k404 } , \
    { k005, k105, k205, k305, k405 } , \
    { k006, k106, k206, k306, k406 } , \
    { k007, k107, k207, k307, k407 } , \
    { k008, k108, k208, k308, k408 }  \
}