cleanCppProject

CleanCppProject

Este é um quadro vazio para o projeto em C ++. Deve ajudar a iniciar um novo projeto sem se importar muito com a configuração do ambiente de projeto/construção.

Características

• Os scripts modernos e simples de criação do CMake, divididos em vários componentes para obter legibilidade.
• Alvos simples e simples para tudo (consulte a seção de metas ).
• Script CPACK que pode produzir Deb , RPM , Windows Installer , Bundle App , DMG e vários pacotes compactados.
• Testes via cTest.
• Testes de unidade via captura.
• Geração de documentação via doxygen (código + diagramas Wiki + UML com GraphViz e Planuml).
• Suporte de análise estática (CLANG-TIDY, CPPCHECK).
• ANÁLISE DÍNICA HELHEDORES ATRAVÉS DE SINITIZADORES (consulte CMake/Sinitizers.cmake).
• Funciona com sua distro Linux favorita, Windows e MacOS.
• Exemplos de configuração Gitlab CI e Travis CI.
• Suporte ao Linker Gold para um tempo de vinculação mais rápido.
• Ajudantes para adicionar dependências externas baixadas durante a configuração ou construção.
  • Veja external/CMakeLists.txt e cmake/cleanCppExtension.cmake

Páginas importantes

• Documento de design
• Lista de Todos (apenas doxygen)
• Estrutura básica do diretório
• Como começar a trabalhar

TODO VEJA como TODO funciona

Como converter isso em seu novo projeto

 git clone https://github.com/kracejic/cleanCppProject.git yourNewProject
cd yourNewProject
mv .git .git-cleanCppProject
git init
git add .
git commit -m "first commit"

Mais em como começar a funcionar.

Como manter o link conosco

Estamos melhorando esse repositório regularmente, se você quiser obter mais de nós, tente puxar o repositório principal.

 cd yourNewProject/ 
git pull --git-dir='.git-cleanCppProject'

Instruções de construção

Pré -requisitos

• Cmake 3.2 e mais recente
• Compilador com suporte para C ++ 14
• Git - para baixar recursos externos
• Doxygen for Docs ( GraphViz para mais gráficos em documentos, Plantuml para mais diagramas UML , Plantuml precisa de java)
• Tools de clang para análise e formatação estática
• CPPcheck para outra análise estática

Pré -requisitos no Linux

• Arch Linux: sudo pacman -S cmake g++ graphviz git clang clang-tools-extra cppcheck java-runtime-common cppcheck

  • baixar plantauml.jar e tenha -o em algum lugar onde o caminho aponte para

• Ubuntu 16.04: sudo apt-get install cmake g++ graphviz plantuml git clang clang-tidy clang-format cppcheck

Pré -requisitos no Windows

Duas maneiras, que foram testadas:

• MSYS2 baseado

  • Mínimo: pacman -S cmake g++ git
  • Software adicional pacman -S clang mingw-w64-x86_64-clang-tools-extra mingw-w64-x86_64-clang-analyzer doxygen
  • Para gráficos na documentação, instale graphviz (para c:Program FilesGraphviz , para que os scripts possam encontrá -lo) e adicione seu subdiretório bin ao caminho , instale o Java (tenha seu diretório bin no caminho ), faça o download do arquivo jar Plantuml e tenha no caminho .

• Microsoft Visual Studio

  • Instale o cmake
  • Instale o git
  • Para recursos adicionais, instale o Clang com ferramentas, doxygen, GraphViz, Plantuml, Java e adicione -as ao caminho ( não testado )

Pré -requisitos no macOS

• MacOS Sierra brew install llvm doxygen cppcheck graphviz

Construa Linux & MacOS

Makefiles padrão:

 mkdir build ; cd build
cmake ..
make -j8

Ninja Build Witch Clang, construa tudo+doc e instale -o na pasta dist:

 mkdir build ; cd build
cmake -GNinja -DCMAKE_CXX_COMPILER="clang++" ..
ninja all doc install

Libere a compilação que se instalará em /usr após sudo make install

 mkdir build ; cd build
cmake .. -DCMAKE_INSTALL_PREFIX="/usr" -DCMAKE_BUILD_TYPE="Release"
make -j8 all
sudo make install

Construir no Windows

Construir no Windows usando msys2 + ninja

No Windows, você deve preferir o ninja, pois é muito mais rápido do que fazer (mas não tem cor no shell).

Com GCC:

 mkdir build ; cd build
cmake -GNinja ..
ninja install

Você pode usar cmake -G "MSYS Makefiles" .. se você quiser usar o Make.

Construa no Windows usando o Microsoft Visual Studio 14

Primeiro, você pode diminuir para alterar o nome do projeto nos principais CMakeLists.txt . Basta ir à pasta com o projeto e criar um novo diretório e criar arquivos de projeto com isso:

 mkdir buildmsvc
cd buildmsvc
cmake -G "Visual Studio 14 2015" ..

E agora você pode abrir um arquivo .sln com o Visual Studio. Você precisa clicar com o botão direito do mouse no destino executável e definir como projeto de inicialização . Para realmente ver a janela do console que você deseja começar sem depuração , pois quando é executado apenas no modo de depuração, a viúva do console é fechada muito rápido.

Alvos

Nota: A disponibilidade de alguns alvos depende da disponibilidade de determinados executáveis ​​(por exemplo, formato de clang para o destino do formato )

• Construir
  • tudo (o padrão se nenhum alvo for fornecido)
  • limpar
  • Instale - Instale binários em cmake_install_prefix
  • ExampleApp - Construir Binário do ExampleApp
  • ExampleApp -Run - Construa, instale e execute o ExampleApp Binary (para sua conveniência)
  • ExampleApp -GDB - Construa, instale e execute o ExampleApp Binisty no GDB (para sua conveniência)
  • Run - Alias ​​para ExampleApp Run (para mantê -lo curto)
• Teste
  • Verifique - Execute o conjunto de testes inteiro (consulte Test/cmakelists.txt)
  • CheckVerbose - Execute o suíte de teste inteiro (consulte test/cmakelists.txt), mas mais detalhado
  • Unidade - Construa e execute apenas testes de unidade (consulte o teste/cmakelists.txt)
  • Unitall - o mesmo que anterior, apenas imprime os resultados de testes de unidade bem -sucedidos
• Lançamentos
  • Pacote - Construa pacotes (ZIP, DEB, RPM, Windows Installer, dependendo do sistema operacional)
• Variado
  • DOC - Crie documentação (se o doxygen estiver disponível)
    • Os documentos podem ser encontrados em build_dir/doc/doc/index.html
    • Se você deseja que eles façam parte do pacote de instalação, a seção de descomamento no final de doc/CMakeLists.txt
  • Formato -Execute o formato Clang em todos os arquivos de origem (.Clang-formato no diretório raiz de um projeto é usado)
  • GDB - Execute o Target Executável com o GDB (não funciona do Ninja, precisa do GDB)
• Análise estática
  • Tidy - Run Clang Static Análise em todas as fontes
  • CPPCHECK - Ligue para o CPPCHECK em todos os arquivos (outra análise estática)
• Externo
  • Atualização - Atualize todas as fontes/projetos externos

Variáveis ​​cmake

• -DCMAKE_INSTALL_PREFIX - Localização para instalação
• -DVERSION_HOST - Construa o nome da máquina, consulte a versão.h.in
• -DCMAKE_BUILD_TYPE - Para o tipo de construção
• -DMEASURE_ALL=ON/OFF - Meça o tempo de todas as compilações, melhor usado com compilação de rosca única. Precisa de comando time (unix).
• -DUSE_GOLD_LINKER=ON/OFF - Se deve vincular -se ao Linker Gold.

Licença

Copyright (c) 2019 Kracejic

A permissão é concedida, gratuita, a qualquer pessoa que obtenha uma cópia deste software e arquivos de documentação associados (o "software"), para lidar com o software sem restrição, inclusive sem limitação os direitos de usar, copiar, modificar, mesclar, publicar, distribuir, mobilizar o software e/ou vender cópias do software e permitir que as pessoas a quem

O aviso de direitos autorais acima e este aviso de permissão devem ser incluídos em todas as cópias ou em partes substanciais do software.

O software é fornecido "como está", sem garantia de qualquer tipo, expresso ou implícito, incluindo, entre outros, as garantias de comercialização, aptidão para uma finalidade específica e não innoculação. Em nenhum caso os autores ou detentores de direitos autorais serão responsáveis ​​por qualquer reclamação, danos ou outro passivo, seja em uma ação de contrato, delito ou não, decorrente de, fora ou em conexão com o software ou o uso ou outras negociações no software.