Serialise validly named model to XML

CMakeLists.txt

@@ -12,35 +12,50 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.cmake_minimum_required (VERSION 3.1)
 
-cmake_minimum_required (VERSION 3.1)
+
+cmake_minimum_required(VERSION 3.2)
 
 set(PROJECT_NAME libCellML)
 project(${PROJECT_NAME} CXX)
 
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
+include(common)
+
 # Use the following variables when configuring the build from the command line to
 # set the corresponding cache variables.
 # TESTS ==> LIBCELLML_TESTS
-set( LIBCELLML_TESTS OFF CACHE BOOL "Enable build of automated LibCellML tests." )
+set(_PARAM_ANNOTATION "Enable build of automated LibCellML tests.")
+set( LIBCELLML_TESTS OFF CACHE BOOL ${_PARAM_ANNOTATION} )
 if( TESTS )
-  set( LIBCELLML_TESTS "${TESTS}" CACHE BOOL "Enable build of automated LibCellML tests." FORCE )
+  set( LIBCELLML_TESTS "${TESTS}" CACHE BOOL ${_PARAM_ANNOTATION} FORCE )
+endif()
+
+# WARNINGS_TREATED_AS_ERRORS ==> LIBCELLML_WARNINGS_TREATED_AS_ERRORS -- Note: This excludes third party code, where warnings are never treated as errors.
+set(_PARAM_ANNOTATION "Treat warnings as errors (note: warnings in 3rd party code are never treated as errors)")
+set( LIBCELLML_WARNINGS_TREATED_AS_ERRORS OFF CACHE BOOL ${_PARAM_ANNOTATION} )
+if( WARNINGS_TREATED_AS_ERRORS )
+  set( LIBCELLML_WARNINGS_TREATED_AS_ERRORS "${WARNINGS_TREATED_AS_ERRORS}" CACHE BOOL ${_PARAM_ANNOTATION} FORCE )
 endif()
 
 # BUILD_TYPE ==> LIBCELLML_BUILD_TYPE
-set( LIBCELLML_BUILD_TYPE "Release" CACHE STRING "Choose the type of build, options are: None(CMAKE_CXX_FLAGS or CMAKE_C_FLAGS used) Debug Release RelWithDebInfo MinSizeRel." )
+set(_PARAM_ANNOTATION "Choose the type of build, options are: None(CMAKE_CXX_FLAGS or CMAKE_C_FLAGS used) Debug Release RelWithDebInfo MinSizeRel.")
+set( LIBCELLML_BUILD_TYPE "Release" CACHE STRING ${_PARAM_ANNOTATION} )
 if( BUILD_TYPE )
-  set( LIBCELLML_BUILD_TYPE ${BUILD_TYPE} CACHE STRING "Choose the type of build, options are: None(CMAKE_CXX_FLAGS or CMAKE_C_FLAGS used) Debug Release RelWithDebInfo MinSizeRel." FORCE )
+  set( LIBCELLML_BUILD_TYPE ${BUILD_TYPE} CACHE STRING ${_PARAM_ANNOTATION} FORCE )
 endif()
 
 # INSTALL_PREFIX ==> LIBCELLML_INSTALL_PREFIX
-set( LIBCELLML_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX} CACHE STRING "Install path prefix, prepended onto install directories." )
+set(_PARAM_ANNOTATION "Install path prefix, prepended onto install directories.")
+set( LIBCELLML_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX} CACHE STRING ${_PARAM_ANNOTATION} )
 if( INSTALL_PREFIX )
-  set( LIBCELLML_INSTALL_PREFIX ${INSTALL_PREFIX} CACHE STRING "Install path prefix, prepended onto install directories." FORCE )
+  set( LIBCELLML_INSTALL_PREFIX ${INSTALL_PREFIX} CACHE STRING ${_PARAM_ANNOTATION} FORCE )
 endif()
 
 # BUILD_SHARED ==> LIBCELLML_BUILD_SHARED
-set( LIBCELLML_BUILD_SHARED OFF CACHE BOOL "Build shared libraries (so, dylib, DLLs)." )
+set(_PARAM_ANNOTATION "Build shared libraries (so, dylib, DLLs).")
+set( LIBCELLML_BUILD_SHARED OFF CACHE BOOL ${_PARAM_ANNOTATION} )
 if( BUILD_SHARED )
-  set( LIBCELLML_BUILD_SHARED ${BUILD_SHARED} CACHE BOOL "Build shared libraries (so, dylib, DLLs)." FORCE )
+  set( LIBCELLML_BUILD_SHARED ${BUILD_SHARED} CACHE BOOL ${_PARAM_ANNOTATION} FORCE )
 endif()
 
 # internalise some CMake variables

cmake/common.cmake

@@ -0,0 +1,31 @@
+# Copyright 2015 University of Auckland
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.cmake_minimum_required (VERSION 3.1)
+
+function(TARGET_WARNINGS_AS_ERRORS _TARGET)
+  set(_COMPILER_WAE)
+  if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
+    set(_COMPILER_WAE -Wall -W -Werror)
+  endif()
+  if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "AppleClang")
+    set(_COMPILER_WAE -Wall -W -Werror)
+  endif()
+  if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC")
+    set(_COMPILER_WAE /W3)
+  endif()
+  if(_COMPILER_WAE)
+    target_compile_options(${_TARGET} PRIVATE ${_COMPILER_WAE})
+  endif()
+  unset(_COMPILER_WAE)
+endfunction()
+

src/CMakeLists.txt

@@ -12,50 +12,75 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.cmake_minimum_required (VERSION 3.1)
 
-
 set(CELLML_EXPORT_H "${CMAKE_CURRENT_BINARY_DIR}/api/libcellml/libcellml_export.h")
 set(LIBCELLML_CONFIG_H "${CMAKE_CURRENT_BINARY_DIR}/libcellml_config.h")
-configure_file (
+configure_file(
   "${CMAKE_CURRENT_SOURCE_DIR}/libcellml_config.h.in"
   ${LIBCELLML_CONFIG_H}
 )
 
 set(SOURCE_FILES
   ${CMAKE_CURRENT_SOURCE_DIR}/version.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/model.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/xml_serialisation.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/cellml_1_2.cpp
 )
 
 set(API_HEADER_FILES
   ${CMAKE_CURRENT_SOURCE_DIR}/api/libcellml/version.h
+  ${CMAKE_CURRENT_SOURCE_DIR}/api/libcellml/model.h
+  ${CMAKE_CURRENT_SOURCE_DIR}/api/libcellml/xml_serialisation.h
+  ${CMAKE_CURRENT_SOURCE_DIR}/cellml_1_2.h
   ${CELLML_EXPORT_H}
 )
 
 set(HEADER_FILES
   ${LIBCELLML_CONFIG_H}
 )
 
-include_directories(
-  ${CMAKE_CURRENT_BINARY_DIR}/api
-  ${CMAKE_CURRENT_SOURCE_DIR}/api
-  ${CMAKE_CURRENT_BINARY_DIR}
-)
-
 include(GenerateExportHeader)
-
 add_compiler_export_flags()
+
 add_library(cellml
   ${SOURCE_FILES}
   ${HEADER_FILES}
   ${API_HEADER_FILES}
 )
-generate_export_header(cellml EXPORT_FILE_NAME ${CELLML_EXPORT_H} BASE_NAME LIBCELLML)
 
-set_source_files_properties(${CELLML_EXPORT_H} PROPERTIES GENERATED TRUE)
+target_include_directories(cellml PRIVATE
+  ${CMAKE_CURRENT_BINARY_DIR}/api
+  ${CMAKE_CURRENT_SOURCE_DIR}/api
+  ${CMAKE_CURRENT_SOURCE_DIR}/../extdep/libxsd
+  ${CMAKE_CURRENT_BINARY_DIR}
+)
 
-# To work around a bug conditionally set the CXX_STANDARD property
-if("${CMAKE_SYSTEM_NAME}" STREQUAL "Linux")
-  set_target_properties(cellml PROPERTIES CXX_STANDARD 11 CXX_STANDARD_REQUIRED ON)
+if(LIBCELLML_WARNINGS_TREATED_AS_ERRORS)
+  target_warnings_as_errors(cellml)
 endif()
 
+generate_export_header(cellml EXPORT_FILE_NAME ${CELLML_EXPORT_H} BASE_NAME LIBCELLML)
+
+set(XercesC_ROOT "${XercesC_ROOT}" CACHE PATH "Location of Xerces-C")
+set(BOOST_ROOT "${BOOST_ROOT}" CACHE PATH "Location of Boost")
+
+set(CMAKE_INCLUDE_PATH "${XercesC_ROOT}/include")
+set(CMAKE_LIBRARY_PATH "${XercesC_ROOT}/lib")
+find_package (XercesC)
+if (XercesC_FOUND)
+  target_include_directories(cellml PRIVATE ${XercesC_INCLUDE_DIR})
+  target_link_libraries (cellml ${XercesC_LIBRARY})
+endif (XercesC_FOUND)
+
+
+find_package (Boost)
+if (Boost_FOUND)
+  target_include_directories(cellml PRIVATE ${Boost_INCLUDE_DIRS})
+  target_link_libraries (cellml ${Boost_LIBRARIES})
+endif (Boost_FOUND)
+
+
+set_source_files_properties(${CELLML_EXPORT_H} PROPERTIES GENERATED TRUE)
+
 export(TARGETS cellml FILE libcellml-exports.cmake)
 
 install(TARGETS cellml EXPORT libcellml-targets
@@ -71,3 +96,4 @@ install(FILES
 
 install(EXPORT libcellml-targets DESTINATION lib/cmake)
 
+set_target_properties(cellml PROPERTIES CXX_STANDARD 11 CXX_STANDARD_REQUIRED ON)

src/api/libcellml/model.h

@@ -0,0 +1,56 @@
+/*
+Copyright 2015 University of Auckland
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.Some license of other
+*/
+
+#ifndef LIBCELLML_LIBCELLML_MODEL_H_
+#define LIBCELLML_LIBCELLML_MODEL_H_
+
+#include <string>
+#include <boost/optional.hpp>
+
+#include "libcellml/libcellml_export.h"
+
+//! Everything in LibCellML is in this namespace.
+namespace libcellml {
+
+//! In-memory representation of a CellML model.
+class LIBCELLML_EXPORT Model {
+  //! Model name
+  boost::optional<std::wstring> name_;
+
+ public:
+  /**
+   * Default constructor.
+   */
+  Model();
+
+  /**
+   * Constructor
+   * \param name The model name
+   */
+  Model(const boost::optional<std::wstring> name);
+
+  /** Model name attribute
+   * \return Model name
+   */
+  boost::optional< std::wstring> getName() const {
+    return name_;
+  }
+
+};
+
+}  // namespace libcellml
+
+#endif  // LIBCELLML_LIBCELLML_MODEL_H_

src/api/libcellml/version.h

@@ -14,8 +14,8 @@ See the License for the specific language governing permissions and
 limitations under the License.Some license of other
 */
 
-#ifndef LIBCELLML_VERSION_H
-#define LIBCELLML_VERSION_H
+#ifndef LIBCELLML_LIBCELLML_VERSION_H_
+#define LIBCELLML_LIBCELLML_VERSION_H_
 
 #include <string>
 
@@ -28,10 +28,10 @@ namespace libcellml {
  * Get the version string.
  * The version string is in the format x.y.z, where the "."s are literal, and x,y and z represent counting numbers,
  * in which case x is the major version, y the minor version, and z the patch level.
- *  @return a string to represent the version
+ *  @return a string to represent the version.
  */
 LIBCELLML_EXPORT const std::string getVersion();
 
-} // namespace libcellml
+}  // namespace libcellml
 
-#endif /* LIBCELLML_VERSION_H */
+#endif  // LIBCELLML_LIBCELLML_VERSION_H_

src/api/libcellml/xml_serialisation.h

@@ -0,0 +1,36 @@
+/*
+Copyright 2015 University of Auckland
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.Some license of other
+*/
+
+#ifndef LIBCELLML_LIBCELLML_XML_SERIALISATION_H_
+#define LIBCELLML_LIBCELLML_XML_SERIALISATION_H_
+
+#include "model.h"
+#include "libcellml/libcellml_export.h"
+
+#include <string>
+
+namespace libcellml {
+
+/**
+ Serialise the Model.
+ \param model The model to be serialised.
+ \return XML representation.
+ */
+std::string LIBCELLML_EXPORT createXml(const Model& model);
+
+}
+
+#endif  // LIBCELLML_LIBCELLML_XML_SERIALISATION_H_