Skip to content

Commit 250e772

Browse files
RaaisRaais
committed
Version and Git Hash in cli + Bump to 1.1.7
1 parent ed994d1 commit 250e772

File tree

7 files changed

+356
-3
lines changed

7 files changed

+356
-3
lines changed

‎CMakeLists.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,18 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
44

55
SET(PROJECT_VERSION_MAJOR 1)
66
SET(PROJECT_VERSION_MINOR 1)
7-
SET(PROJECT_VERSION_PATCH 6)
7+
SET(PROJECT_VERSION_PATCH 7)
8+
9+
SET(PROJECT_VERSION_STRING "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH}")
10+
add_compile_definitions(PROJECT_VERSION_STRING="${PROJECT_VERSION_STRING}")
811

912
project(ImStudio C CXX)
1013

1114
list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
15+
include(GetGitRevisionDescription)
16+
get_git_head_revision(GIT_REFSPEC GIT_SHA1)
17+
add_compile_definitions(GIT_SHA1="${GIT_SHA1}")
18+
1219
if (WIN32 OR APPLE)
1320
include(glfw)
1421
else() # Linux

‎build.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ if test X${S_UNAME} = "XLinux"
2626
cd ${BUILD_DIR}
2727

2828
# build
29-
cmake -DOpenGL_GL_PREFERENCE=GLVND \
29+
cmake -DOpenGL_GL_PREFERENCE=${OPENGL_GL_PREFERENCE} \
3030
..
3131
make -j4
3232

‎cmake/GetGitRevisionDescription.cmake

Lines changed: 284 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,284 @@
1+
# - Returns a version string from Git
2+
#
3+
# These functions force a re-configure on each git commit so that you can
4+
# trust the values of the variables in your build system.
5+
#
6+
# get_git_head_revision(<refspecvar> <hashvar> [ALLOW_LOOKING_ABOVE_CMAKE_SOURCE_DIR])
7+
#
8+
# Returns the refspec and sha hash of the current head revision
9+
#
10+
# git_describe(<var> [<additional arguments to git describe> ...])
11+
#
12+
# Returns the results of git describe on the source tree, and adjusting
13+
# the output so that it tests false if an error occurs.
14+
#
15+
# git_describe_working_tree(<var> [<additional arguments to git describe> ...])
16+
#
17+
# Returns the results of git describe on the working tree (--dirty option),
18+
# and adjusting the output so that it tests false if an error occurs.
19+
#
20+
# git_get_exact_tag(<var> [<additional arguments to git describe> ...])
21+
#
22+
# Returns the results of git describe --exact-match on the source tree,
23+
# and adjusting the output so that it tests false if there was no exact
24+
# matching tag.
25+
#
26+
# git_local_changes(<var>)
27+
#
28+
# Returns either "CLEAN" or "DIRTY" with respect to uncommitted changes.
29+
# Uses the return code of "git diff-index --quiet HEAD --".
30+
# Does not regard untracked files.
31+
#
32+
# Requires CMake 2.6 or newer (uses the 'function' command)
33+
#
34+
# Original Author:
35+
# 2009-2020 Ryan Pavlik <[email protected]> <[email protected]>
36+
# http://academic.cleardefinition.com
37+
#
38+
# Copyright 2009-2013, Iowa State University.
39+
# Copyright 2013-2020, Ryan Pavlik
40+
# Copyright 2013-2020, Contributors
41+
# SPDX-License-Identifier: BSL-1.0
42+
# Distributed under the Boost Software License, Version 1.0.
43+
# (See accompanying file LICENSE_1_0.txt or copy at
44+
# http://www.boost.org/LICENSE_1_0.txt)
45+
46+
if(__get_git_revision_description)
47+
return()
48+
endif()
49+
set(__get_git_revision_description YES)
50+
51+
# We must run the following at "include" time, not at function call time,
52+
# to find the path to this module rather than the path to a calling list file
53+
get_filename_component(_gitdescmoddir ${CMAKE_CURRENT_LIST_FILE} PATH)
54+
55+
# Function _git_find_closest_git_dir finds the next closest .git directory
56+
# that is part of any directory in the path defined by _start_dir.
57+
# The result is returned in the parent scope variable whose name is passed
58+
# as variable _git_dir_var. If no .git directory can be found, the
59+
# function returns an empty string via _git_dir_var.
60+
#
61+
# Example: Given a path C:/bla/foo/bar and assuming C:/bla/.git exists and
62+
# neither foo nor bar contain a file/directory .git. This wil return
63+
# C:/bla/.git
64+
#
65+
function(_git_find_closest_git_dir _start_dir _git_dir_var)
66+
set(cur_dir "${_start_dir}")
67+
set(git_dir "${_start_dir}/.git")
68+
while(NOT EXISTS "${git_dir}")
69+
# .git dir not found, search parent directories
70+
set(git_previous_parent "${cur_dir}")
71+
get_filename_component(cur_dir "${cur_dir}" DIRECTORY)
72+
if(cur_dir STREQUAL git_previous_parent)
73+
# We have reached the root directory, we are not in git
74+
set(${_git_dir_var}
75+
""
76+
PARENT_SCOPE)
77+
return()
78+
endif()
79+
set(git_dir "${cur_dir}/.git")
80+
endwhile()
81+
set(${_git_dir_var}
82+
"${git_dir}"
83+
PARENT_SCOPE)
84+
endfunction()
85+
86+
function(get_git_head_revision _refspecvar _hashvar)
87+
_git_find_closest_git_dir("${CMAKE_CURRENT_SOURCE_DIR}" GIT_DIR)
88+
89+
if("${ARGN}" STREQUAL "ALLOW_LOOKING_ABOVE_CMAKE_SOURCE_DIR")
90+
set(ALLOW_LOOKING_ABOVE_CMAKE_SOURCE_DIR TRUE)
91+
else()
92+
set(ALLOW_LOOKING_ABOVE_CMAKE_SOURCE_DIR FALSE)
93+
endif()
94+
if(NOT "${GIT_DIR}" STREQUAL "")
95+
file(RELATIVE_PATH _relative_to_source_dir "${CMAKE_SOURCE_DIR}"
96+
"${GIT_DIR}")
97+
if("${_relative_to_source_dir}" MATCHES "[.][.]" AND NOT ALLOW_LOOKING_ABOVE_CMAKE_SOURCE_DIR)
98+
# We've gone above the CMake root dir.
99+
set(GIT_DIR "")
100+
endif()
101+
endif()
102+
if("${GIT_DIR}" STREQUAL "")
103+
set(${_refspecvar}
104+
"GITDIR-NOTFOUND"
105+
PARENT_SCOPE)
106+
set(${_hashvar}
107+
"GITDIR-NOTFOUND"
108+
PARENT_SCOPE)
109+
return()
110+
endif()
111+
112+
# Check if the current source dir is a git submodule or a worktree.
113+
# In both cases .git is a file instead of a directory.
114+
#
115+
if(NOT IS_DIRECTORY ${GIT_DIR})
116+
# The following git command will return a non empty string that
117+
# points to the super project working tree if the current
118+
# source dir is inside a git submodule.
119+
# Otherwise the command will return an empty string.
120+
#
121+
execute_process(
122+
COMMAND "${GIT_EXECUTABLE}" rev-parse
123+
--show-superproject-working-tree
124+
WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
125+
OUTPUT_VARIABLE out
126+
ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
127+
if(NOT "${out}" STREQUAL "")
128+
# If out is empty, GIT_DIR/CMAKE_CURRENT_SOURCE_DIR is in a submodule
129+
file(READ ${GIT_DIR} submodule)
130+
string(REGEX REPLACE "gitdir: (.*)$" "\\1" GIT_DIR_RELATIVE
131+
${submodule})
132+
string(STRIP ${GIT_DIR_RELATIVE} GIT_DIR_RELATIVE)
133+
get_filename_component(SUBMODULE_DIR ${GIT_DIR} PATH)
134+
get_filename_component(GIT_DIR ${SUBMODULE_DIR}/${GIT_DIR_RELATIVE}
135+
ABSOLUTE)
136+
set(HEAD_SOURCE_FILE "${GIT_DIR}/HEAD")
137+
else()
138+
# GIT_DIR/CMAKE_CURRENT_SOURCE_DIR is in a worktree
139+
file(READ ${GIT_DIR} worktree_ref)
140+
# The .git directory contains a path to the worktree information directory
141+
# inside the parent git repo of the worktree.
142+
#
143+
string(REGEX REPLACE "gitdir: (.*)$" "\\1" git_worktree_dir
144+
${worktree_ref})
145+
string(STRIP ${git_worktree_dir} git_worktree_dir)
146+
_git_find_closest_git_dir("${git_worktree_dir}" GIT_DIR)
147+
set(HEAD_SOURCE_FILE "${git_worktree_dir}/HEAD")
148+
endif()
149+
else()
150+
set(HEAD_SOURCE_FILE "${GIT_DIR}/HEAD")
151+
endif()
152+
set(GIT_DATA "${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/git-data")
153+
if(NOT EXISTS "${GIT_DATA}")
154+
file(MAKE_DIRECTORY "${GIT_DATA}")
155+
endif()
156+
157+
if(NOT EXISTS "${HEAD_SOURCE_FILE}")
158+
return()
159+
endif()
160+
set(HEAD_FILE "${GIT_DATA}/HEAD")
161+
configure_file("${HEAD_SOURCE_FILE}" "${HEAD_FILE}" COPYONLY)
162+
163+
configure_file("${_gitdescmoddir}/GetGitRevisionDescription.cmake.in"
164+
"${GIT_DATA}/grabRef.cmake" @ONLY)
165+
include("${GIT_DATA}/grabRef.cmake")
166+
167+
set(${_refspecvar}
168+
"${HEAD_REF}"
169+
PARENT_SCOPE)
170+
set(${_hashvar}
171+
"${HEAD_HASH}"
172+
PARENT_SCOPE)
173+
endfunction()
174+
175+
function(git_describe _var)
176+
if(NOT GIT_FOUND)
177+
find_package(Git QUIET)
178+
endif()
179+
get_git_head_revision(refspec hash)
180+
if(NOT GIT_FOUND)
181+
set(${_var}
182+
"GIT-NOTFOUND"
183+
PARENT_SCOPE)
184+
return()
185+
endif()
186+
if(NOT hash)
187+
set(${_var}
188+
"HEAD-HASH-NOTFOUND"
189+
PARENT_SCOPE)
190+
return()
191+
endif()
192+
193+
# TODO sanitize
194+
#if((${ARGN}" MATCHES "&&") OR
195+
# (ARGN MATCHES "||") OR
196+
# (ARGN MATCHES "\\;"))
197+
# message("Please report the following error to the project!")
198+
# message(FATAL_ERROR "Looks like someone's doing something nefarious with git_describe! Passed arguments ${ARGN}")
199+
#endif()
200+
201+
#message(STATUS "Arguments to execute_process: ${ARGN}")
202+
203+
execute_process(
204+
COMMAND "${GIT_EXECUTABLE}" describe --tags --always ${hash} ${ARGN}
205+
WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
206+
RESULT_VARIABLE res
207+
OUTPUT_VARIABLE out
208+
ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
209+
if(NOT res EQUAL 0)
210+
set(out "${out}-${res}-NOTFOUND")
211+
endif()
212+
213+
set(${_var}
214+
"${out}"
215+
PARENT_SCOPE)
216+
endfunction()
217+
218+
function(git_describe_working_tree _var)
219+
if(NOT GIT_FOUND)
220+
find_package(Git QUIET)
221+
endif()
222+
if(NOT GIT_FOUND)
223+
set(${_var}
224+
"GIT-NOTFOUND"
225+
PARENT_SCOPE)
226+
return()
227+
endif()
228+
229+
execute_process(
230+
COMMAND "${GIT_EXECUTABLE}" describe --dirty ${ARGN}
231+
WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
232+
RESULT_VARIABLE res
233+
OUTPUT_VARIABLE out
234+
ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
235+
if(NOT res EQUAL 0)
236+
set(out "${out}-${res}-NOTFOUND")
237+
endif()
238+
239+
set(${_var}
240+
"${out}"
241+
PARENT_SCOPE)
242+
endfunction()
243+
244+
function(git_get_exact_tag _var)
245+
git_describe(out --exact-match ${ARGN})
246+
set(${_var}
247+
"${out}"
248+
PARENT_SCOPE)
249+
endfunction()
250+
251+
function(git_local_changes _var)
252+
if(NOT GIT_FOUND)
253+
find_package(Git QUIET)
254+
endif()
255+
get_git_head_revision(refspec hash)
256+
if(NOT GIT_FOUND)
257+
set(${_var}
258+
"GIT-NOTFOUND"
259+
PARENT_SCOPE)
260+
return()
261+
endif()
262+
if(NOT hash)
263+
set(${_var}
264+
"HEAD-HASH-NOTFOUND"
265+
PARENT_SCOPE)
266+
return()
267+
endif()
268+
269+
execute_process(
270+
COMMAND "${GIT_EXECUTABLE}" diff-index --quiet HEAD --
271+
WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
272+
RESULT_VARIABLE res
273+
OUTPUT_VARIABLE out
274+
ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
275+
if(res EQUAL 0)
276+
set(${_var}
277+
"CLEAN"
278+
PARENT_SCOPE)
279+
else()
280+
set(${_var}
281+
"DIRTY"
282+
PARENT_SCOPE)
283+
endif()
284+
endfunction()

‎cmake/GetGitRevisionDescription.cmake.in

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
#
2+
# Internal file for GetGitRevisionDescription.cmake
3+
#
4+
# Requires CMake 2.6 or newer (uses the 'function' command)
5+
#
6+
# Original Author:
7+
# 2009-2010 Ryan Pavlik <[email protected]> <[email protected]>
8+
# http://academic.cleardefinition.com
9+
# Iowa State University HCI Graduate Program/VRAC
10+
#
11+
# Copyright 2009-2012, Iowa State University
12+
# Copyright 2011-2015, Contributors
13+
# Distributed under the Boost Software License, Version 1.0.
14+
# (See accompanying file LICENSE_1_0.txt or copy at
15+
# http://www.boost.org/LICENSE_1_0.txt)
16+
# SPDX-License-Identifier: BSL-1.0
17+
18+
set(HEAD_HASH)
19+
20+
file(READ "@HEAD_FILE@" HEAD_CONTENTS LIMIT 1024)
21+
22+
string(STRIP "${HEAD_CONTENTS}" HEAD_CONTENTS)
23+
if(HEAD_CONTENTS MATCHES "ref")
24+
# named branch
25+
string(REPLACE "ref: " "" HEAD_REF "${HEAD_CONTENTS}")
26+
if(EXISTS "@GIT_DIR@/${HEAD_REF}")
27+
configure_file("@GIT_DIR@/${HEAD_REF}" "@GIT_DATA@/head-ref" COPYONLY)
28+
else()
29+
configure_file("@GIT_DIR@/packed-refs" "@GIT_DATA@/packed-refs" COPYONLY)
30+
file(READ "@GIT_DATA@/packed-refs" PACKED_REFS)
31+
if(${PACKED_REFS} MATCHES "([0-9a-z]*) ${HEAD_REF}")
32+
set(HEAD_HASH "${CMAKE_MATCH_1}")
33+
endif()
34+
endif()
35+
else()
36+
# detached HEAD
37+
configure_file("@GIT_DIR@/HEAD" "@GIT_DATA@/head-ref" COPYONLY)
38+
endif()
39+
40+
if(NOT HEAD_HASH)
41+
file(READ "@GIT_DATA@/head-ref" HEAD_HASH LIMIT 1024)
42+
string(STRIP "${HEAD_HASH}" HEAD_HASH)
43+
endif()

‎src/includes.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,10 @@
2020
#ifdef __EMSCRIPTEN__
2121
#include "utils/JsClipboardTricks.h"
2222
#include "utils/HyperlinkHelper.h"
23+
#endif
24+
#ifndef PROJECT_VERSION_STRING
25+
#define PROJECT_VERSION_STRING "0.0.0"
26+
#endif
27+
#ifndef GIT_SHA1
28+
#define GIT_SHA1 "0000000"
2329
#endif

‎src/main.cpp

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,19 @@ static void glfw_error_callback(int error, const char *description)
1818

1919
int main(int argc, char *argv[])
2020
{
21+
if (argc > 1)
22+
{
23+
if (strcmp(argv[1], "-v") == 0 || strcmp(argv[1], "--version") == 0)
24+
{
25+
printf("%s\n", PROJECT_VERSION_STRING);
26+
return 0;
27+
}
28+
if (strcmp(argv[1], "--hash") == 0)
29+
{
30+
printf("%s\n", GIT_SHA1);
31+
return 0;
32+
}
33+
}
2134
int w_w = 900;
2235
int w_h = 600;
2336
glfwSetErrorCallback(glfw_error_callback);

‎src/utils/utils.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ void utils::ShowAboutWindow(bool *child_about)
304304
{
305305
TextCentered("ImStudio");
306306
ImGui::Separator();
307-
ImGui::Text("Version: 1.1.6");
307+
TextCentered(PROJECT_VERSION_STRING);
308308
ImGui::Text("Source: Raais/ImStudio");
309309
ImGui::Text("ImGui: 18500 (55d35d8)");
310310
ImGui::Text("Fmt: 8.0.1 (d141cdb)");

0 commit comments

Comments
 (0)