Browse Source

Rename generate_qtprotobuf to qtprotobuf_generate

Fixes: #53
Alexey Edelev 5 years ago
parent
commit
8ba76d00e3

+ 4 - 4
README.md

@@ -113,7 +113,7 @@ file(GLOB PROTO_FILES ABSOLUTE ${CMAKE_CURRENT_SOURCE_DIR}/path/to/protofile1.pr
 # Function below generates source files for specified PROTO_FILES,
 # writes result to STATIC library target and saves its name to 
 # ${QtProtobuf_GENERATED} variable
-generate_qtprotobuf(TARGET MyTarget
+qtprotobuf_generate(TARGET MyTarget
     OUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/generated
     PROTO_FILES ${PROTO_FILES})
 add_executable(MyTarget main.cpp) # Add your target here
@@ -133,7 +133,7 @@ set(GENERATED_HEADERS
     ...
     )
 ...
-generate_qtprotobuf(TARGET MyTarget
+qtprotobuf_generate(TARGET MyTarget
     OUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/generated
     PROTO_FILES ${PROTO_FILES}
     GENERATED_HEADERS ${GENERATED_HEADERS})
@@ -182,9 +182,9 @@ Following properties will be generated:
 
 ## CMake functions reference
 
-### generate_qtprotobuf
+### qtprotobuf_generate
 
-generate_qtprotobuf is cmake helper function that automatically generates STATIC library target from your .proto files
+qtprotobuf_generate is cmake helper function that automatically generates STATIC library target from your .proto files
 
 Due to cmake restrictions it's required to specify resulting artifacts manually as list of header files expected after generator job finished.
 

+ 1 - 1
cmake/QtProtobufCommon.cmake

@@ -62,7 +62,7 @@ function(add_test_target)
         file(GLOB PROTO_FILES ABSOLUTE ${CMAKE_CURRENT_SOURCE_DIR}/proto/*.proto)
     endif()
 
-    generate_qtprotobuf(TARGET ${add_test_target_TARGET}
+    qtprotobuf_generate(TARGET ${add_test_target_TARGET}
         OUT_DIR ${GENERATED_SOURCES_DIR}
         PROTO_FILES ${PROTO_FILES}
         GENERATED_HEADERS ${add_test_target_GENERATED_HEADERS}

+ 22 - 22
cmake/QtProtobufGen.cmake

@@ -1,29 +1,29 @@
-function(generate_qtprotobuf)
+function(qtprotobuf_generate)
     set(options)
     set(oneValueArgs OUT_DIR TARGET MULTI QML GENERATED_HEADERS_VAR)
     set(multiValueArgs GENERATED_HEADERS EXCLUDE_HEADERS PROTO_FILES PROTO_INCLUDES)
-    cmake_parse_arguments(generate_qtprotobuf "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+    cmake_parse_arguments(qtprotobuf_generate "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
 
-    set(QtProtobuf_GENERATED ${generate_qtprotobuf_TARGET}_qtprotobuf_gen PARENT_SCOPE)
-    set(QtProtobuf_GENERATED ${generate_qtprotobuf_TARGET}_qtprotobuf_gen)
+    set(QtProtobuf_GENERATED ${qtprotobuf_generate_TARGET}_qtprotobuf_gen PARENT_SCOPE)
+    set(QtProtobuf_GENERATED ${qtprotobuf_generate_TARGET}_qtprotobuf_gen)
 
-    set(GEN_TARGET ${generate_qtprotobuf_TARGET}_qtprotobuf_generate)
-    set(GENERATED_HEADERS ${generate_qtprotobuf_GENERATED_HEADERS})
+    set(GEN_TARGET ${qtprotobuf_generate_TARGET}_qtprotobuf_generate)
+    set(GENERATED_HEADERS ${qtprotobuf_generate_GENERATED_HEADERS})
 
     if(NOT DEFINED QTPROTOBUF_EXECUTABLE)
         set(QTPROTOBUF_EXECUTABLE "${QTPROTOBUF_EXECUTABLE_INSTALL}")
     endif()
 
     set(GENERATION_TYPE "SINGLE")
-    if("${generate_qtprotobuf_MULTI}" STREQUAL "TRUE")
+    if("${qtprotobuf_generate_MULTI}" STREQUAL "TRUE")
         set(GENERATION_TYPE "MULTI")
         #TODO: add globalenums by default. But it's better to verify if proto file contains any global enum
         set(GENERATED_HEADERS ${GENERATED_HEADERS} globalenums.h)
     endif()
 
     set(GENERATION_OPTIONS ${GENERATION_TYPE})
-    if("${generate_qtprotobuf_QML}" STREQUAL "TRUE")
-        message(STATUS "Enabled QML generation for ${generate_qtprotobuf_TARGET}")
+    if("${qtprotobuf_generate_QML}" STREQUAL "TRUE")
+        message(STATUS "Enabled QML generation for ${qtprotobuf_generate_TARGET}")
         set(GENERATION_OPTIONS "${GENERATION_OPTIONS}:QML")
     endif()
 
@@ -32,8 +32,8 @@ function(generate_qtprotobuf)
         message(FATAL_ERROR "Golang is mandatory dependency for QtProtobuf. Please install it and ensure that it's accessible by PATH environment variable")
     endif()
 
-    set(PROTO_INCLUDES ${generate_qtprotobuf_PROTO_INCLUDES})
-    foreach(PROTO_FILE IN LISTS generate_qtprotobuf_PROTO_FILES)
+    set(PROTO_INCLUDES ${qtprotobuf_generate_PROTO_INCLUDES})
+    foreach(PROTO_FILE IN LISTS qtprotobuf_generate_PROTO_FILES)
         get_filename_component(BASE_DIR ${PROTO_FILE} DIRECTORY)
         set(PROTO_INCLUDES -I"${BASE_DIR}" ${PROTO_INCLUDES})
         execute_process(COMMAND ${GO_EXECUTABLE} run ${PROTO_PARSER} ${PROTO_FILE} ${GENERATION_TYPE} OUTPUT_VARIABLE GENERATED_HEADERS_PART ERROR_VARIABLE PARSER_ERROR)
@@ -44,20 +44,20 @@ function(generate_qtprotobuf)
         message(FATAL_ERROR "Go parser error ${PARSER_ERROR}")
     endif()
 
-    if(DEFINED generate_qtprotobuf_GENERATED_HEADERS)
-        set(GENERATED_HEADERS ${generate_qtprotobuf_GENERATED_HEADERS})
+    if(DEFINED qtprotobuf_generate_GENERATED_HEADERS)
+        set(GENERATED_HEADERS ${qtprotobuf_generate_GENERATED_HEADERS})
     endif()
 
-    foreach(EXCLUDE_HEADER IN LISTS generate_qtprotobuf_EXCLUDE_HEADERS)
+    foreach(EXCLUDE_HEADER IN LISTS qtprotobuf_generate_EXCLUDE_HEADERS)
         list(REMOVE_ITEM GENERATED_HEADERS ${EXCLUDE_HEADER})
     endforeach()
 
     list(REMOVE_DUPLICATES GENERATED_HEADERS)
 
-    if(NOT DEFINED generate_qtprotobuf_OUT_DIR)
+    if(NOT DEFINED qtprotobuf_generate_OUT_DIR)
         set(OUT_DIR ${CMAKE_CURRENT_BINARY_DIR})
     else()
-        set(OUT_DIR ${generate_qtprotobuf_OUT_DIR})
+        set(OUT_DIR ${qtprotobuf_generate_OUT_DIR})
     endif()
 
     file(MAKE_DIRECTORY ${OUT_DIR})
@@ -85,15 +85,15 @@ function(generate_qtprotobuf)
                 --plugin=protoc-gen-${GENERATOR_TARGET}=${QTPROTOBUF_EXECUTABLE}
                 --${GENERATOR_TARGET}_out=${OUT_DIR}
                 ${PROTO_INCLUDES}
-                ${generate_qtprotobuf_PROTO_FILES}
+                ${qtprotobuf_generate_PROTO_FILES}
             WORKING_DIRECTORY ${OUT_DIR}
-            DEPENDS ${generate_qtprotobuf_PROTO_FILES} ${QTPROTOBUF_EXECUTABLE}
-            COMMENT "Generating QtProtobuf ${generate_qtprotobuf_TARGET} sources..."
+            DEPENDS ${qtprotobuf_generate_PROTO_FILES} ${QTPROTOBUF_EXECUTABLE}
+            COMMENT "Generating QtProtobuf ${qtprotobuf_generate_TARGET} sources..."
     )
 
-    add_custom_target(${GEN_TARGET} DEPENDS ${QTPROTOBUF_GENERATED_SOURCES} ${QTPROTOBUF_GENERATED_HEADERS} ${generate_qtprotobuf_PROTO_FILES})
-    if(NOT "${generate_qtprotobuf_GENERATED_HEADERS_VAR}" STREQUAL "")
-        set(${generate_qtprotobuf_GENERATED_HEADERS_VAR} ${QTPROTOBUF_GENERATED_HEADERS} PARENT_SCOPE)
+    add_custom_target(${GEN_TARGET} DEPENDS ${QTPROTOBUF_GENERATED_SOURCES} ${QTPROTOBUF_GENERATED_HEADERS} ${qtprotobuf_generate_PROTO_FILES})
+    if(NOT "${qtprotobuf_generate_GENERATED_HEADERS_VAR}" STREQUAL "")
+        set(${qtprotobuf_generate_GENERATED_HEADERS_VAR} ${QTPROTOBUF_GENERATED_HEADERS} PARENT_SCOPE)
     endif()
     qt5_wrap_cpp(MOC_SOURCES ${QTPROTOBUF_GENERATED_HEADERS})
     list(APPEND GENERATED_SOURCES ${MOC_SOURCES})

+ 1 - 1
examples/addressbook/CMakeLists.txt

@@ -9,7 +9,7 @@ find_package(QtProtobufProject CONFIG REQUIRED COMPONENTS QtProtobuf QtGrpc)
 
 file(GLOB PROTO_FILES ABSOLUTE ${CMAKE_CURRENT_SOURCE_DIR}/proto/addressbook.proto)
 
-generate_qtprotobuf(TARGET ${TARGET}
+qtprotobuf_generate(TARGET ${TARGET}
     OUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/generated
     PROTO_FILES ${PROTO_FILES}
     QML TRUE)

+ 1 - 1
examples/simplechat/CMakeLists.txt

@@ -9,7 +9,7 @@ find_package(QtProtobufProject CONFIG REQUIRED COMPONENTS QtProtobuf QtGrpc)
 
 file(GLOB PROTO_FILES ABSOLUTE ${CMAKE_CURRENT_SOURCE_DIR}/proto/simplechat.proto)
 
-generate_qtprotobuf(TARGET ${TARGET}
+qtprotobuf_generate(TARGET ${TARGET}
     OUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/generated
     PROTO_FILES ${PROTO_FILES}
     QML TRUE)

+ 1 - 1
src/protobuf/qabstractprotobufserializer.h

@@ -62,7 +62,7 @@ class QProtobufMetaObject;
  *          };
  *          \endcode
  *          Practically code above is generated automaticaly by running qtprotobufgenerator or using cmake build macro
- *          generate_qtprotobuf, based on .proto files. But it's still possible to reuse manually written code if needed.
+ *          qtprotobuf_generate, based on .proto files. But it's still possible to reuse manually written code if needed.
  *
  *          This class should be used as base for specific serializers. The handlers property contains all
  *          message-specific serializers and should be used while serialization/deserialization. Inherited classes should reimplement

+ 1 - 1
src/wellknowntypes/CMakeLists.txt

@@ -36,7 +36,7 @@ function(add_wellknowntype VARIABLE TYPENAME)
         file(GLOB PROTO_FILE ${INCLUDE_DIR}/google/protobuf/${TYPENAME}.proto)
         if (NOT "${PROTO_FILE}" STREQUAL "")
             message(STATUS "Add well-known type ${PROTO_FILE}")
-            generate_qtprotobuf(TARGET ${TYPENAME}
+            qtprotobuf_generate(TARGET ${TYPENAME}
                 OUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/generated/google/protobuf
                 PROTO_FILES ${PROTO_FILE}
                 PROTO_INCLUDES -I${QTPROTOBUF_SOURCE_DIR}/3rdparty/grpc/third_party/protobuf/src