kst-2.0.3/cmake/CMakeLists.txt.user 000644 001750 001750 00000053566 11544160206 017504 0 ustar 00synth synth 000000 000000
ProjectExplorer.Project.ActiveTarget0ProjectExplorer.Project.EditorSettingsSystemProjectExplorer.Project.Target.0DesktopCMakeProjectManager.DefaultCMakeTarget00/home/synth/sandbox/kst/_cmakefalseMakeCMakeProjectManager.MakeStep1cleantrueMakeCMakeProjectManager.MakeStep1falseallCMakeProjectManager.CMakeBuildConfiguration12falsefalse$BUILDDIRBenutzerdefinierte, ausführbare DateiProjectExplorer.CustomExecutableRunConfiguration2kst2/home/synth/sandbox/kst/_cmake/build/bin/kst2false/home/synth/sandbox/kst/_cmake/build/binkst2CMakeProjectManager.CMakeRunConfiguration.2test_labelparser/home/synth/sandbox/kst/_cmake/build/bin/test_labelparserfalse/home/synth/sandbox/kst/_cmake/build/bintest_labelparserCMakeProjectManager.CMakeRunConfiguration.2test_matrix/home/synth/sandbox/kst/_cmake/build/bin/test_matrixfalse/home/synth/sandbox/kst/_cmake/build/bintest_matrixCMakeProjectManager.CMakeRunConfiguration.2test_objectstore/home/synth/sandbox/kst/_cmake/build/bin/test_objectstorefalse/home/synth/sandbox/kst/_cmake/build/bintest_objectstoreCMakeProjectManager.CMakeRunConfiguration.2test_psd/home/synth/sandbox/kst/_cmake/build/bin/test_psdfalse/home/synth/sandbox/kst/_cmake/build/bintest_psdCMakeProjectManager.CMakeRunConfiguration.2test_scalar/home/synth/sandbox/kst/_cmake/build/bin/test_scalarfalse/home/synth/sandbox/kst/_cmake/build/bintest_scalarCMakeProjectManager.CMakeRunConfiguration.2test_vector/home/synth/sandbox/kst/_cmake/build/bin/test_vectorfalse/home/synth/sandbox/kst/_cmake/build/bintest_vectorCMakeProjectManager.CMakeRunConfiguration.2test_csd/home/synth/sandbox/kst/_cmake/build/bin/test_csdfalse/home/synth/sandbox/kst/_cmake/build/bintest_csdCMakeProjectManager.CMakeRunConfiguration.2test_datamatrix/home/synth/sandbox/kst/_cmake/build/bin/test_datamatrixfalse/home/synth/sandbox/kst/_cmake/build/bintest_datamatrixCMakeProjectManager.CMakeRunConfiguration.2test_datasource/home/synth/sandbox/kst/_cmake/build/bin/test_datasourcefalse/home/synth/sandbox/kst/_cmake/build/bintest_datasourceCMakeProjectManager.CMakeRunConfiguration.2test_editablematrix/home/synth/sandbox/kst/_cmake/build/bin/test_editablematrixfalse/home/synth/sandbox/kst/_cmake/build/bintest_editablematrixCMakeProjectManager.CMakeRunConfiguration.2test_eqparser/home/synth/sandbox/kst/_cmake/build/bin/test_eqparserfalse/home/synth/sandbox/kst/_cmake/build/bintest_eqparserCMakeProjectManager.CMakeRunConfiguration.2test_generatedmatrix/home/synth/sandbox/kst/_cmake/build/bin/test_generatedmatrixfalse/home/synth/sandbox/kst/_cmake/build/bintest_generatedmatrixCMakeProjectManager.CMakeRunConfiguration.2test_generatedvector/home/synth/sandbox/kst/_cmake/build/bin/test_generatedvectorfalse/home/synth/sandbox/kst/_cmake/build/bintest_generatedvectorCMakeProjectManager.CMakeRunConfiguration.2test_histogram/home/synth/sandbox/kst/_cmake/build/bin/test_histogramfalse/home/synth/sandbox/kst/_cmake/build/bintest_histogramCMakeProjectManager.CMakeRunConfiguration.16ProjectExplorer.Project.TargetCount1ProjectExplorer.Project.Updater.FileVersion4
kst-2.0.3/cmake/modules/FindGsl.cmake 000644 001750 001750 00000002035 11544160206 017750 0 ustar 00synth synth 000000 000000
# use pkg to find the library name and pathes,
# but use this iformation in find_* only
include(FindPkgConfig)
pkg_check_modules(PKGGSL QUIET gsl)
if(NOT PKGGSL_LIBRARIES)
set(PKGGSL_LIBRARIES gsl)
if (UNIX)
set(PKGGSL_LIBRARIES ${PKGGSL_LIBRARIES} m gslcblas)
endif()
endif()
set(GSL_INCLUDEDIR GSL_INCLUDEDIR-NOTFOUND CACHE STRING "" FORCE)
find_path(GSL_INCLUDEDIR gsl_version.h
HINTS
ENV GSL_DIR
PATH_SUFFIXES include/gsl include
PATHS ${kst_3rdparty_dir} ${PKGGSL_INCLUDEDIR})
foreach(it ${PKGGSL_LIBRARIES})
set(lib lib-NOTFOUND CACHE STRING "" FORCE)
FIND_LIBRARY(lib ${it}
HINTS
ENV GSL_DIR
PATH_SUFFIXES lib
PATHS ${kst_3rdparty_dir} ${PKGGSL_LIBRARY_DIRS})
list(APPEND GSL_LIBRARIES ${lib})
endforeach()
if(GSL_INCLUDEDIR AND GSL_LIBRARIES)
set(GSL_INCLUDE_DIR ${GSL_INCLUDEDIR} ${GSL_INCLUDEDIR}/..)
set(gsl 1)
message(STATUS "Found Gsl:")
message(STATUS " includes : ${GSL_INCLUDE_DIR}")
message(STATUS " libraries: ${GSL_LIBRARIES}")
else()
message(STATUS "Not found: Gsl, set GSL_DIR")
endif()
kst-2.0.3/cmake/modules/FindDmc.cmake 000644 001750 001750 00000002335 11544160206 017731 0 ustar 00synth synth 000000 000000
#include(FindPkgConfig)
#pkg_check_modules(PostgreSQL libpq-dev)
if(DMC_INCLUDEDIR AND DMC_LIBRARIES)
set(DMC_LIBRARY -L${DMC_LIBRARY_DIRS} ${DMC_LIBRARIES})
else()
set(DMC_INCLUDEDIR DMC_INCLUDEDIR-NOTFOUND CACHE STRING "" FORCE)
FIND_PATH(PQ_DIR libpq-fe.h
HINTS
ENV PQ_DIR
PATH_SUFFIXES include
PATHS)
FIND_PATH(PIO_DB PIODB.h
HINTS
ENV DMC_DIR
PATH_SUFFIXES HL2_DMC include/HL2_DMC
PATHS)
FIND_PATH(PIO_ERR PIOErr.h
HINTS
ENV DMC_DIR
PATH_SUFFIXES HL2_PIOLIB include/HL2_PIOLIB
PATHS)
if(PIO_DB AND PIO_ERR AND PQ_DIR)
set(DMC_INCLUDEDIR ${PIO_DB}/..)
endif()
if(NOT PIO_DB STREQUAL PIO_ERR)
set(DMC_INCLUDEDIR ${DMC_INCLUDEDIR} ${PIO_ERR}/..)
endif()
FIND_LIBRARY(DMC_LIBRARY piolib
HINTS
ENV DMC_DIR
PATH_SUFFIXES lib lib/Linux-x86_64
PATHS)
endif()
#message(STATUS "PIO_DB ${PIO_DB}")
#message(STATUS "PIO_ERR ${PIO_ERR}")
#message(STATUS "PQ_H ${PQ_H}")
IF(DMC_INCLUDEDIR AND DMC_LIBRARY AND PQ_DIR)
MESSAGE(STATUS "DMC found at ${DMC_INCLUDEDIR}")
SET(DMC_INCLUDE_DIR ${DMC_INCLUDEDIR} ${PQ_DIR})
SET(DMC_LIBRARIES ${DMC_LIBRARY})
SET(dmc 1)
ELSE()
MESSAGE(STATUS "DMC not found.")
ENDIF()
#message(STATUS "DMC: ${DMC_INCLUDEDIR}")
#message(STATUS "DMC: ${DMC_LIBRARIES}")
kst-2.0.3/cmake/modules/SubversionGenerator.cmake 000644 001750 001750 00000003163 11544160206 022433 0 ustar 00synth synth 000000 000000
find_package(Subversion)
if(SUBVERSION_FOUND)
# try with 'svnversion'
get_filename_component(svn_dir ${Subversion_SVN_EXECUTABLE} PATH)
find_program(svnversion_bin svnversion PATH ${svn_dir})
if(svnversion_bin)
execute_process(
COMMAND ${svnversion_bin} ${source_dir}
OUTPUT_VARIABLE _revision
ERROR_VARIABLE _error
RESULT_VARIABLE _result
OUTPUT_STRIP_TRAILING_WHITESPACE)
else()
# extract revision
Subversion_WC_INFO(${source_dir} src)
set(_revision "${src_WC_REVISION}")
# check for modifications
execute_process(
COMMAND ${Subversion_SVN_EXECUTABLE} status ${source_dir}
OUTPUT_VARIABLE src_WC_STATUS
ERROR_VARIABLE _error
RESULT_VARIABLE _result
OUTPUT_STRIP_TRAILING_WHITESPACE)
# problems with multiple lines,
# http://www.mail-archive.com/cmake@cmake.org/msg07254.html
string(REGEX REPLACE "\r?\n" ";" lines "${src_WC_STATUS}")
set(_modified)
foreach(line ${lines})
string(REGEX MATCH "^(.*\n)?M ([^\n]+).*" _found "${line}")
if(_found)
#message(STATUS "Modified file: ${_found}")
set(_modified ${_modified} _found)
endif()
endforeach()
if(_modified)
set(_revision "${_revision}${modified_str}")
endif()
endif()
# write a file with the SVN_REVISION define
file(WRITE ${header_file}.tmp "#define SVN_REVISION \"${_revision}\"\n")
else()
file(WRITE ${header_file}.tmp "#define SVN_REVISION \"unknown\"\n")
endif()
message(STATUS "Revision: ${_revision}")
# copy the file to the final header only if
# the version changes reduces needless rebuilds
execute_process(COMMAND ${CMAKE_COMMAND}
-E copy_if_different
${header_file}.tmp ${header_file})
kst-2.0.3/cmake/modules/FindGetdata.cmake 000644 001750 001750 00000003674 11544160206 020606 0 ustar 00synth synth 000000 000000
include(FindPkgConfig)
pkg_check_modules(PKGGETDATA QUIET getdata>=0.6.0)
#message(STATUS "GD inc: ${PKGGETDATA_INCLUDEDIR}")
#message(STATUS "GD libs: ${PKGGETDATA_LIBRARIES}")
# Apple: install getdata with --prefix /opt/local
# FIXME: GETDATA_INCLUDEDIR AND GETDATA_LIBRARIES are set by pkg_check_modules, but
# GETDATA_LIBRARY_C and GETDATA_LIBRARY_CPP are not.
# Ubuntu: maybe /usr/local/lib/pkgconfig/getdata.pc is not correct
#if(NOT PKGGETDATA_LIBRARIES)
set(PKGGETDATA_LIBRARIES getdata++ getdata)
if (UNIX)
SET(PKGGETDATA_LIBRARIES ${PKGGETDATA_LIBRARIES} m)
endif()
#endif()
set(GETDATA_INCLUDEDIR GETDATA_INCLUDEDIR-NOTFOUND CACHE STRING "" FORCE)
FIND_PATH(GETDATA_INCLUDEDIR getdata.h
HINTS
ENV GETDATA_DIR
PATH_SUFFIXES include/getdata include
PATHS ${kst_3rdparty_dir} ${GETDATA_INCLUDEDIR})
foreach(it ${PKGGETDATA_LIBRARIES})
set(lib_release lib_release-NOTFOUND CACHE STRING "" FORCE)
FIND_LIBRARY(lib_release ${it}
HINTS ENV GETDATA_DIR PATH_SUFFIXES lib
PATHS ${kst_3rdparty_dir} ${PKGGETDATA_LIBRARY_DIRS})
list(APPEND GETDATA_LIBRARIES_RELEASE ${lib_release})
list(APPEND GETDATA_LIBRARIES_BOTH optimized ${lib_release})
set(lib_debug lib_debug-NOTFOUND CACHE STRING "" FORCE)
FIND_LIBRARY(lib_debug ${it}d
HINTS ENV GETDATA_DIR PATH_SUFFIXES lib
PATHS ${kst_3rdparty_dir} ${PKGGETDATA_LIBRARY_DIRS})
list(APPEND GETDATA_LIBRARIES_DEBUG ${lib_debug})
list(APPEND GETDATA_LIBRARIES_BOTH debug ${lib_debug})
endforeach()
if(GETDATA_LIBRARIES_DEBUG AND GETDATA_LIBRARIES_RELEASE)
set(GETDATA_LIBRARIES ${GETDATA_LIBRARIES_BOTH})
else()
set(GETDATA_LIBRARIES ${GETDATA_LIBRARIES_RELEASE})
endif()
IF(GETDATA_INCLUDEDIR AND GETDATA_INCLUDEDIR)
SET(GETDATA_INCLUDE_DIR ${GETDATA_INCLUDEDIR})
SET(getdata 1)
message(STATUS "Found GetData:")
message(STATUS " includes : ${GETDATA_INCLUDE_DIR}")
message(STATUS " libraries: ${GETDATA_LIBRARIES}")
ELSE()
MESSAGE(STATUS "Not found: Getdata, GETDATA_DIR")
ENDIF()
kst-2.0.3/cmake/modules/SubversionHeader.cmake 000644 001750 001750 00000001071 11544160206 021671 0 ustar 00synth synth 000000 000000
macro(SubversionHeader source_dir target_name header_file modified_str)
# a custom target that is always built
# creates ${header_file} using SubversionGenerator.cmake script
add_custom_target(${target_name} ALL
COMMAND ${CMAKE_COMMAND}
-Dsource_dir="${source_dir}"
-Dheader_file="${header_file}"
-Dmodified_str="${modified_str}"
-P ${CMAKE_CURRENT_SOURCE_DIR}/modules/SubversionGenerator.cmake)
# ${header_file} is a generated file
set_source_files_properties(${header_file}
PROPERTIES
GENERATED TRUE
HEADER_FILE_ONLY TRUE)
endmacro()
kst-2.0.3/cmake/modules/FindCFITSIO.cmake 000644 001750 001750 00000002076 11544160206 020330 0 ustar 00synth synth 000000 000000
include(FindPkgConfig)
pkg_check_modules(cfitsio QUIET cfitsio)
if(CFITSIO_INCLUDEDIR AND CFITSIO_LIBRARIES)
set(CFITSIO_LIBRARY -L${CFITSIO_LIBRARY_DIRS} ${CFITSIO_LIBRARIES})
else()
set(CFITSIO_INCLUDEDIR CFITSIO_INCLUDEDIR-NOTFOUND CACHE STRING "" FORCE)
FIND_PATH(CFITSIO_INCLUDEDIR fitsio.h
HINTS
ENV CFITSIO_DIR
PATH_SUFFIXES include include/cfitsio include/libcfitsio0
PATHS ${kst_3rdparty_dir}
)
FIND_LIBRARY(CFITSIO_LIBRARIES cfitsio
HINTS
ENV CFITSIO_DIR
PATH_SUFFIXES lib
PATHS ${kst_3rdparty_dir}
)
endif()
#message(STATUS "CFITSIO: ${CFITSIO_INCLUDEDIR}")
#message(STATUS "CFITSIO: ${CFITSIO_LIBRARIES}")
IF(CFITSIO_INCLUDEDIR AND CFITSIO_LIBRARIES)
SET(CFITSIO_INCLUDE_DIR ${CFITSIO_INCLUDEDIR} ${CFITSIO_INCLUDEDIR}/..)
if (UNIX)
SET(CFITSIO_LIBRARIES ${CFITSIO_LIBRARIES} m)
endif()
SET(CFITSIO 1)
SET(cfitsio 1)
message(STATUS "Found CFITSIO:")
message(STATUS " includes : ${CFITSIO_INCLUDE_DIR}")
message(STATUS " libraries: ${CFITSIO_LIBRARIES}")
ELSE()
MESSAGE(STATUS "Not found: CFITSIO, set CFITSIO_DIR")
ENDIF()
kst-2.0.3/cmake/modules/KstPchSupport.cmake 000644 001750 001750 00000005660 11544160206 021222 0 ustar 00synth synth 000000 000000
# Not supported officially my cmake
# but there is a cmake ticket with examples
# http://www.vtk.org/Bug/view.php?id=1260
# use this macro before
#
# _header : header to make a .gch
# _sources: the variable name (do not use ${..}) which contains a
# a list of sources (a.cpp b.cpp c.cpp ...)
# This macro will append a header file to it, then this
# src_list can be used in
#
# Now a .gch file should be generated and gcc should use it.
# (add -Winvalid-pch to the cpp flags to verify)
#
# make clean should delete the pch file
#
# example : kst_add_pch_rule(pch.h source_list_name SHARED)
macro(kst_add_pch_rule _header _sources _lib_type)
if(CMAKE_COMPILER_IS_GNUCC)
# first we have to find all compiler arguments
get_directory_property(_definitions COMPILE_DEFINITIONS)
foreach (_it ${_definitions})
list(APPEND _args "-D${_it}")
endforeach()
list(APPEND _args ${CMAKE_CXX_FLAGS})
if(CMAKE_BUILD_TYPE MATCHES Release)
list(APPEND _args ${CMAKE_CXX_FLAGS_RELEASE})
get_directory_property(_definitions_type COMPILE_DEFINITIONS_RELEASE)
else()
list(APPEND _args ${CMAKE_CXX_FLAGS_DEBUG})
get_directory_property(_definitions_type COMPILE_DEFINITIONS_DEBUG)
endif()
if(${_lib_type} MATCHES SHARED)
list(APPEND _args ${CMAKE_SHARED_LIBRARY_CXX_FLAGS})
endif()
list(APPEND _args -D${_definitions_type})
#message(STATUS "pch: ${_args}")
get_directory_property(DIRINC INCLUDE_DIRECTORIES)
foreach (_inc ${DIRINC})
LIST(APPEND _args "-I" ${_inc})
endforeach(_inc ${DIRINC})
set(_gch_filename "${_header}.gch")
list(APPEND ${_sources} ${_gch_filename})
list(APPEND _args -c ${_header} -o ${_gch_filename})
separate_arguments(_args)
# now build the pch with the compiler arguments
add_custom_command(OUTPUT ${_gch_filename}
COMMAND ${CMAKE_COMMAND} -E remove ${_gch_filename}
COMMAND ${CMAKE_CXX_COMPILER} ${CMAKE_CXX_COMPILER_ARG1} ${_args}
DEPENDS ${_header})
# all other files should use the pch
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Winvalid-pch -include ${_header}")
else()
file(WRITE ${_header}.tmp "#include \"${_header}\"\n")
execute_process(COMMAND ${CMAKE_COMMAND} -E copy_if_different ${_header}.tmp ${_header}.cpp)
if(MSVC_IDE)
set(use_pch "/Fp${_header}.\$(Configuration).pch")
else()
set(use_pch /Fp${_header}.pch)
endif()
set_source_files_properties(${_header}.cpp PROPERTIES COMPILE_FLAGS "/Yc\"${_header}\" ${use_pch}")
# Bug in cmake: next line also compile .c files with pchs
#set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /FI${_header} /Yu${_header} ${use_pch}")
foreach(it ${${_sources}})
get_filename_component(ext ${it} EXT)
if(ext STREQUAL .c)
else()
set_source_files_properties(${it} PROPERTIES COMPILE_FLAGS "/FI${_header} /Yu${_header} ${use_pch}")
endif()
endforeach()
list(APPEND ${_sources} ${_header} ${_header}.cpp)
endif()
endmacro()
kst-2.0.3/cmake/modules/KstMacros.cmake 000644 001750 001750 00000022216 11544160206 020333 0 ustar 00synth synth 000000 000000 include(MergedFilesBuild)
include(KstPchSupport)
macro(kst_dbg)
foreach(it ${ARGN})
message(STATUS "dgb: ${it} = ${${it}}")
endforeach()
endmacro()
macro(kst_init prefix name_base)
set(kst_name ${prefix}${name_base})
set(kst_name_base ${name_base})
set(kst_${kst_name}_dont_merge)
set(kst_${kst_name}_ignore)
set(kst_${kst_name}_info_files)
endmacro()
macro(kst_revision_project_name name)
set(kst_revision_project ${name})
endmacro()
macro(kst_revision_add_dependency)
if(kst_revision_project)
add_dependencies(${kst_name} ${kst_revision_project})
endif()
endmacro()
macro(kst_files_find folder)
set(_folder ${kst_dir}/${folder})
file(GLOB _sources ${_folder}/*.c)
file(GLOB _sources_cpp ${_folder}/*.cpp)
file(GLOB _headers ${_folder}/*.h)
file(GLOB _ui_files ${_folder}/*.ui)
set(kst_${kst_name}_folder ${_folder})
kst_files_remove(_sources ${kst_${kst_name}_ignore})
kst_files_remove(_sources_cpp ${kst_${kst_name}_ignore})
kst_files_remove(_headers ${kst_${kst_name}_ignore})
set(_mocs)
qt4_wrap_cpp(_mocs ${_headers} OPTIONS "-nw")
set(_uis)
qt4_wrap_ui(_uis ${_ui_files})
set(kst_${kst_name}_sources_not_generated ${_sources} ${_sources_cpp})
set(kst_${kst_name}_sources ${_sources} ${_sources_cpp} ${_mocs} ${_uis})
set(kst_${kst_name}_headers ${_headers})
set(kst_${kst_name}_mocs ${_mocs})
set(kst_${kst_name}_ui_files ${_ui_files})
set(kst_${kst_name}_uis ${_uis})
set(kst_${kst_name}_includes ${_folder} ${CMAKE_CURRENT_BINARY_DIR} CACHE STRING "Include dir for ${kst_name}" FORCE)
source_group("Ui" FILES ${_mocs} ${_ui_files})
source_group("Generated" FILES ${_mocs} ${_uis})
endmacro()
macro(kst_dont_merge)
set(kst_${kst_name}_dont_merge)
foreach(_it ${ARGV})
set(kst_${kst_name}_dont_merge ${kst_${kst_name}_dont_merge} ${kst_${kst_name}_folder}/${_it})
endforeach()
endmacro()
macro(kst_add_executable)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${kst_build_dir}/bin)
include_directories(${kst_${kst_name}_folder} ${CMAKE_CURRENT_BINARY_DIR})
add_executable(${kst_name} ${ARGN} ${kst_${kst_name}_sources} ${kst_${kst_name}_headers} ${kst_${kst_name}_info_files})
target_link_libraries(${kst_name} ${kst_qtmain_library})
set_property(TARGET ${kst_name} PROPERTY DEBUG_POSTFIX ${kst_debug_postfix})
kst_revision_add_dependency()
kst_flat_source_group(${kst_${kst_name}_headers} ${kst_${kst_name}_sources_not_generated})
endmacro()
macro(kst_install_executable)
install(TARGETS ${kst_name}
RUNTIME DESTINATION bin
BUNDLE DESTINATION .)
endmacro()
macro(kst_add_library type)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${kst_build_dir}/bin)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${kst_build_dir}/${kst_install_libdir})
include_directories(${kst_${kst_name}_folder} ${CMAKE_CURRENT_BINARY_DIR})
string(TOUPPER BUILD_kst${kst_name_base} _build_macro)
add_definitions(-D${_build_macro})
if(kst_pch)
set(pch kst${kst_name_base}_pch)
configure_file(${kst_${kst_name}_folder}/${pch} ${CMAKE_CURRENT_BINARY_DIR}/${pch}.h COPYONLY)
#add_definitions(-DKST_PCH_RECURSIVE) # only some percents faster
kst_add_pch_rule(${CMAKE_CURRENT_BINARY_DIR}/${pch}.h kst_${kst_name}_sources ${type})
endif()
if(kst_merge_files)
if(kst_merge_rebuild)
set(merged_files_rebuild 1)
endif()
kst_files_remove(kst_${kst_name}_sources ${kst_${kst_name}_dont_merge})
kst_files_remove(kst_${kst_name}_dont_merge ${kst_${kst_name}_ignore})
kst_files_remove(kst_${kst_name}_sources_not_generated ${kst_${kst_name}_dont_merge})
merged_files_build(merged kst_${kst_name}_sources)
set(depends_moc_uic ${kst_${kst_name}_headers} ${kst_${kst_name}_uis} ${kst_${kst_name}_ui_files} ${kst_${kst_name}_mocs})
set_source_files_properties(merged_const.cpp PROPERTIES OBJECT_DEPENDS "${depends_moc_uic}")
set_source_files_properties(merged_touched.cpp PROPERTIES OBJECT_DEPENDS "${depends_moc_uic}")
add_library(${kst_name} ${type} ${merged_files} ${kst_${kst_name}_dont_merge} ${kst_${kst_name}_headers} ${kst_${kst_name}_uis} ${kst_${kst_name}_sources_not_generated} ${svnversion_h})
foreach(_it ${kst_${kst_name}_sources_not_generated})
set_source_files_properties(${_it} PROPERTIES HEADER_FILE_ONLY TRUE)
endforeach()
source_group("Source Files" Files)
source_group("Header Files" Files)
else()
add_library(${kst_name} ${type} ${kst_${kst_name}_sources} ${kst_${kst_name}_headers} ${svnversion_h})
kst_flat_source_group(${kst_${kst_name}_headers} ${kst_${kst_name}_sources_not_generated})
endif()
set(lib${kst_name_base} ${kst_name} CACHE STRING "actual ${kst_name} name" FORCE)
set_property(TARGET ${kst_name} PROPERTY DEBUG_POSTFIX ${kst_debug_postfix})
set_target_properties(${kst_name} PROPERTIES VERSION ${kst_version} SOVERSION ${kst_version_major})
kst_revision_add_dependency()
if(WIN32)
if(NOT ${type} STREQUAL "STATIC")
install(TARGETS ${kst_name} RUNTIME DESTINATION bin)
endif()
elseif(NOT APPLE)
install(TARGETS ${kst_name} DESTINATION ${kst_install_libdir})
endif()
endmacro()
macro(kst_init_plugin dir)
if(APPLE AND NOT CMAKE_GENERATOR STREQUAL Xcode)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${kst_build_dir}/bin/${kst_binary_name}.app/Contents/plugins)
else()
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${kst_build_dir}/${kst_install_plugins})
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${kst_build_dir}/${kst_install_plugins})
endif()
include_directories(${CMAKE_BINARY_DIR}/${dir})
kst_include_directories(core math widgets)
set(kst_plugin_dir ${dir})
set(kst_plugin_prefix ${ARGN})
endmacro()
macro(kst_add_plugin folder name)
set(_name _${kst_plugin_prefix}_${folder}_${name})
string(REPLACE . _ _name ${_name})
string(REPLACE / _ _name ${_name})
string(REPLACE __ _ _name ${_name})
string(REPLACE __ _ _name ${_name})
kst_init(${kst_binary_name} ${_name})
kst_files_find(${kst_plugin_dir}/${folder}/${name})
add_library(${kst_name} MODULE ${kst_${kst_name}_sources} ${kst_${kst_name}_headers})
kst_link(${libcore} ${libmath} ${libwidgets})
if(NOT APPLE)
install(TARGETS ${kst_name} LIBRARY DESTINATION ${kst_install_plugins})
kst_find_install_desktop_file(${kst_plugin_dir}/${folder}/${name})
endif()
add_dependencies(${kst_binary_name} ${kst_name})
kst_flat_source_group(${kst_${kst_name}_headers} ${kst_${kst_name}_sources_not_generated})
if(kst_verbose)
message(STATUS "Building plugin ${kst_name}")
endif()
endmacro()
macro(kst_include_directories)
foreach(_it ${ARGV})
include_directories(${kst_${kst_binary_name}${_it}_includes})
endforeach()
endmacro()
macro(kst_find_install_desktop_file folder)
if(UNIX)
file(GLOB _desktop_file ${kst_dir}/${folder}/*.desktop)
install(FILES ${_desktop_file} DESTINATION ${kst_install_plugin_desktop_file_path})
endif()
endmacro()
macro(kst_link)
target_link_libraries(${kst_name} ${ARGV}
${QT_QTCORE_LIBRARY} ${QT_QTGUI_LIBRARY} ${QT_QTXML_LIBRARY} ${QT_QTOPENGL_LIBRARY} ${QT_QTSVG_LIBRARY})
endmacro()
macro(kst_files_ignore)
set(kst_${kst_name}_ignore ${kst_${kst_name}_ignore} ${ARGV})
endmacro()
macro(kst_files_remove list)
foreach(_item ${ARGN})
set(_file ${kst_${kst_name}_folder}/${_item})
if(${list})
list(REMOVE_ITEM ${list} ${_item} ${_file} ${_file}.cpp ${_file}.c ${_file}.h)
endif()
endforeach()
endmacro()
macro(kst_add_files)
set(kst_${kst_name}_sources ${kst_${kst_name}_sources} ${ARGN})
endmacro()
macro(kst_add_resources filepath)
qt4_add_resources(_rcc ${kst_dir}/${filepath})
kst_add_files(${_rcc})
endmacro()
macro(kst_option_init)
set(kst_options)
endmacro()
macro(kst_option _name _description _default _sys)
set(_msg OFF)
if(${_sys} MATCHES "gcc")
set(_system CMAKE_COMPILER_IS_GNUCXX)
elseif(${_sys} MATCHES "win")
set(_system WIN32)
else()
set(_system ${_sys})
endif()
if(${_system} MATCHES "all")
option(kst_${_name} ${_description} ${_default})
set(_msg ON)
else()
if(${${_system}})
option(kst_${_name} ${_description} ${_default})
set(_msg ON)
endif()
endif()
list(APPEND kst_options kst_${_name})
set(kst_${_name}_description ${_description})
set(kst_${_name}_show_message ${_msg})
endmacro()
macro(kst_option_list_all)
foreach(_option ${kst_options})
if(${${_option}_show_message})
string(SUBSTRING "${_option} " 0 25 _var)
if(${_option})
set(_isset ON)
else()
set(_isset OFF)
endif()
string(SUBSTRING "${_isset} " 0 4 _val)
message(STATUS "${_var}= ${_val} : ${${_option}_description}")
endif()
endforeach()
endmacro()
macro(kst_add_info_files group)
foreach(_it ${ARGN})
if(NOT IS_DIRECTORY ${_it})
get_filename_component(name ${_it} NAME)
if(NOT ${_it} MATCHES "^/\\\\..*$;~$")
set_source_files_properties(${_it} PROPERTIES HEADER_FILE_ONLY TRUE)
set(kst_${group}_info_files ${kst_${group}_info_files} ${_it})
endif()
endif()
endforeach()
source_group(${group} FILES ${kst_${group}_info_files})
set(kst_${kst_name}_info_files ${kst_${kst_name}_info_files} ${kst_${group}_info_files})
endmacro()
macro(kst_find_info_files group files)
file(GLOB _filelist ${files})
kst_add_info_files(${group} ${_filelist})
endmacro()
macro(kst_flat_source_group)
source_group("Source Files" Files)
source_group("Header Files" Files)
source_group("CMakeLists" FILES CMakeLists.txt)
source_group("Headers/Sources" FILES ${ARGN})
endmacro()
kst-2.0.3/cmake/modules/MergedFilesBuild.cmake 000644 001750 001750 00000004504 11544160206 021573 0 ustar 00synth synth 000000 000000
macro(merged_files_build _allinone_name _list)
set(_file_list ${_allinone_name}_files)
set(_file_const ${CMAKE_CURRENT_BINARY_DIR}/${_allinone_name}_const.cpp)
set(_file_touched ${CMAKE_CURRENT_BINARY_DIR}/${_allinone_name}_touched.cpp)
# don't touch exisiting or non-empty file,
# so a cmake re-run doesn't touch all created files
set(_rebuild_file_const 0)
if (NOT EXISTS ${_file_const})
set(_rebuild_file_const 1)
else()
FILE(READ ${_file_const} _file_content)
if (NOT _file_content)
set(_rebuild_file_const 1)
endif()
endif()
set(_rebuild_file_touched 0)
if (NOT EXISTS ${_file_touched})
set(_rebuild_file_touched 1)
else()
FILE(READ ${_file_touched} _file_content)
if (NOT _file_content)
set(_rebuild_file_touched 1)
endif()
endif()
if (merged_files_rebuild)
set(_rebuild_file_const 1)
set(_rebuild_file_touched 1)
endif()
if (_rebuild_file_const)
file(WRITE ${_file_const} "// autogenerated file \n//\n")
file(APPEND ${_file_const} "// * clear or delete this file to build it again by cmake \n//\n\n")
endif()
if (_rebuild_file_touched)
file(WRITE ${_file_touched} "// autogenerated file \n//\n")
file(APPEND ${_file_touched} "// * clear or delete this file to build it again by cmake \n//\n")
file(APPEND ${_file_touched} "// * don't touch this file \n//\n\n")
file(APPEND ${_file_touched} "#define DONT_INCLUDE_CONST_FILES\n")
file(APPEND ${_file_touched} "#include \"${_file_const}\"\n\n\n")
endif()
set(${_file_list} ${_file_const} ${_file_touched})
foreach (_current_FILE ${${_list}})
get_filename_component(_abs_FILE ${_current_FILE} ABSOLUTE)
GET_FILENAME_COMPONENT(_file_name ${_abs_FILE} NAME_WE)
STRING(REGEX REPLACE "-" "_" _file_name "${_file_name}")
set(__macro_name ${_file_name}___ASSUME_CONST)
if (_rebuild_file_const)
file(APPEND ${_file_const} "#define ${__macro_name}\n")
file(APPEND ${_file_const} "#if defined(${__macro_name}) && !defined(DONT_INCLUDE_CONST_FILES)\n")
file(APPEND ${_file_const} "#include \"${_abs_FILE}\"\n")
file(APPEND ${_file_const} "#endif\n\n")
endif()
if (_rebuild_file_touched)
file(APPEND ${_file_touched} "#ifndef ${__macro_name}\n")
file(APPEND ${_file_touched} "#include \"${_abs_FILE}\"\n")
file(APPEND ${_file_touched} "#endif\n\n")
endif()
endforeach (_current_FILE)
endmacro()
kst-2.0.3/cmake/modules/FindNetcdf.cmake 000644 001750 001750 00000003370 11544160206 020431 0 ustar 00synth synth 000000 000000
include(FindPkgConfig)
pkg_check_modules(NETCDF QUIET netcdf)
if(NETCDF_INCLUDEDIR AND NETCDF_LIBRARIES)
FIND_LIBRARY(NETCDF_LIBRARY_CPP netcdf_c++
HINTS ${NETCDF_LIBRARY_DIRS})
set(NETCDF_LIBRARY_C -L${NETCDF_LIBRARY_DIRS} ${NETCDF_LIBRARIES})
else()
set(NETCDF_INCLUDEDIR NETCDF_INCLUDEDIR-NOTFOUND CACHE STRING "" FORCE)
FIND_PATH(NETCDF_INCLUDEDIR netcdf.h
HINTS
ENV NETCDF_DIR
PATH_SUFFIXES include
PATHS
${kst_3rdparty_dir}
~/Library/Frameworks
/Library/Frameworks
)
macro(find_netcdf_lib var libname)
FIND_LIBRARY(${var} ${libname}
HINTS
ENV NETCDF_DIR
PATH_SUFFIXES lib
PATHS ${kst_3rdparty_dir})
endmacro()
find_netcdf_lib(netcdf_c netcdf)
find_netcdf_lib(netcdf_c_debug netcdfd)
find_netcdf_lib(netcdf_cpp netcdf_c++)
find_netcdf_lib(netcdf_cpp_debug netcdf_c++d)
if(netcdf_c AND netcdf_c_debug)
set(NETCDF_LIBRARY_C optimized ${netcdf_c} debug ${netcdf_c_debug})
endif()
if(netcdf_cpp AND netcdf_cpp_debug)
set(NETCDF_LIBRARY_CPP optimized ${netcdf_cpp} debug ${netcdf_cpp_debug})
endif()
if(NOT MSVC)
# only msvc needs debug and release
set(NETCDF_LIBRARY_C ${netcdf_c})
set(NETCDF_LIBRARY_CPP ${netcdf_cpp})
endif()
endif()
#message(STATUS "NETCDF: ${NETCDF_INCLUDEDIR}")
#message(STATUS "NETCDF: ${NETCDF_LIBRARY_C}")
#message(STATUS "NETCDF: ${NETCDF_LIBRARY_CPP}")
IF(NETCDF_INCLUDEDIR AND NETCDF_LIBRARY_C AND NETCDF_LIBRARY_CPP)
SET(NETCDF_LIBRARIES ${NETCDF_LIBRARY_CPP} ${NETCDF_LIBRARY_C})
SET(NETCDF_INCLUDE_DIR ${NETCDF_INCLUDEDIR})
SET(netcdf 1)
message(STATUS "Found NetCDF:")
message(STATUS " includes : ${NETCDF_INCLUDE_DIR}")
message(STATUS " libraries: ${NETCDF_LIBRARIES}")
ELSE()
MESSAGE(STATUS "Not found: NetCDF, set NETCDF_DIR")
ENDIF()
kst-2.0.3/cmake/tests/allinone/CMakeLists.txt 000644 001750 001750 00000000326 11544160206 021454 0 ustar 00synth synth 000000 000000
kst_init(${kst_binary_name} tests)
kst_files_find(tests)
kst_include_directories(core math)
remove_definitions(-DKST_USE_QTEST_MAIN)
kst_add_executable()
kst_link(${libcore} ${libmath} ${QT_QTTEST_LIBRARY})
kst-2.0.3/cmake/tests/CMakeLists.txt 000644 001750 001750 00000001746 11544160206 017662 0 ustar 00synth synth 000000 000000 project(ksttests)
file(GLOB test_headers ${kst_dir}/tests/*.h)
list(REMOVE_ITEM test_headers ${kst_dir}/tests/ksttest.h)
kst_include_directories(core math)
add_definitions(-DKST_USE_QTEST_MAIN -DKST_SRC_DIR=${kst_dir})
foreach(header ${test_headers})
get_filename_component(filename ${header} NAME_WE)
string(REPLACE test test_ testname ${filename})
if(kst_verbose)
message(STATUS "Building test ${testname}")
endif()
kst_init(${testname} "")
set(moc_file)
qt4_wrap_cpp(moc_file ${header} OPTIONS "-nw")
kst_add_executable(
${kst_dir}/tests/ksttest.h
${kst_dir}/tests/${filename}.cpp
${header} ${moc_file})
kst_link(${libcore} ${libmath} ${QT_QTTEST_LIBRARY})
add_test(NAME ${testname} COMMAND ${testname})
# Some file grouping in Studio
kst_flat_source_group()
source_group(Generated FILES ${moc_file})
endforeach()
message(STATUS)
message(STATUS "Tests added, to run them call 'make test'")
message(STATUS)
# like done with qmake
#add_subdirectory(allinone)
kst-2.0.3/cmake/CMakeLists.txt 000644 001750 001750 00000022514 11544160206 016514 0 ustar 00synth synth 000000 000000 cmake_minimum_required(VERSION 2.8)
project(Kst)
set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/modules")
include(KstMacros)
get_filename_component(kst_dir ${CMAKE_SOURCE_DIR}/.. ABSOLUTE)
get_filename_component(kst_build_dir ${CMAKE_BINARY_DIR}/build ABSOLUTE)
set(kst_version_major 2)
set(kst_version_minor 0)
set(kst_version_patch 3)
set(kst_version ${kst_version_major}.${kst_version_minor}.${kst_version_patch})
set(kst_binary_name kst2)
kst_option_init()
kst_option(release "Build release version: optimize for speed, don't embedded debug symbols" OFF all)
kst_option(merge_files "Merge files to speedup build about factor 5" OFF all)
kst_option(merge_rebuild "Rebuild generated files from merged files build" OFF all)
kst_option(verbose "Make verbose CMake run and Makefiles" OFF all)
kst_option(install_prefix "Install path for Kst, using a default if not set" OFF all)
kst_option(install_libdir "Install directory name for libraries" OFF all)
kst_option(3rdparty "Build plugins depending on 3rd party libraries" ON all)
kst_option(dataobjects "Build dataobject plugins" ON all)
kst_option(test "Build unit tests" OFF all)
kst_option(pch "Use precompiled headers" ON all)
kst_option(svnversion "Use svnversion's output for Kst's version information" ON all)
kst_option(rpath "Use rpath" ON gcc)
kst_option(3rdparty_download "Download precompiled 3rd party libraries" OFF win)
kst_option(console "Open console on Windows" OFF win)
kst_option(edit_cont "Enable \"Edit and Continue\" for Visual Studio" OFF win)
message(STATUS)
if(kst_3rdparty_download)
message(STATUS "Checking downloaded 3rd party binaries.")
set(_deps kst-3rdparty-win32-deps)
set(_file ${_deps}.tar.bz2)
set(_downloaded _downloaded-NOTFOUND CACHE PATH "3rd party binaries already downloaded" FORCE)
find_file(_downloaded ${_file} ${CMAKE_BINARY_DIR})
if (NOT _downloaded)
# TODO move to sf.net, but sf.net is broken atm (Jan 30 2011)
file(DOWNLOAD http://kst-plot.kde.org/download/${_file} ${CMAKE_BINARY_DIR}/${_file}
EXPECTED_MD5 d2ffdb6dad509fe40f1cc9f60c88ddd5
SHOW_PROGRESS)
execute_process(COMMAND ${CMAKE_COMMAND} -E tar -xfj ${CMAKE_BINARY_DIR}/${_file})
endif()
set(kst_3rdparty_dir ${CMAKE_BINARY_DIR}/${_deps}-1.0)
endif()
kst_revision_project_name(Revision)
add_definitions(-DKST_HAVE_SVN_REVISION_H)
if(kst_svnversion)
include(SubversionHeader)
SubversionHeader(${kst_dir} ${kst_revision_project} ${CMAKE_BINARY_DIR}/svnrevision.h _modified)
else()
file(WRITE ${CMAKE_BINARY_DIR}/svnrevision.h.tmp "#define SVN_REVISION \"unknown\"\n")
configure_file(${CMAKE_BINARY_DIR}/svnrevision.h.tmp ${CMAKE_BINARY_DIR}/svnrevision.h COPYONLY)
endif()
# Find 3rd party libraries
find_package(Qt4 REQUIRED)
include(${QT_USE_FILE})
if(MINGW)
# seems there is a bug in FindQt4
macro(fix_it)
foreach(_it ${ARGN})
if(QT_${_it}_LIBRARY_DEBUG AND QT_${_it}_LIBRARY_RELEASE)
set(QT_${_it}_LIBRARY debug ${QT_${_it}_LIBRARY_DEBUG} optimized ${QT_${_it}_LIBRARY_RELEASE} CACHE STRING "Fixed ${_it}" FORCE)
endif()
endforeach()
endmacro()
fix_it(QTCORE QTGUI QTXML QTSVG QTOPENGL)
endif()
message(STATUS)
if(kst_3rdparty)
message(STATUS "3rd party libs for plugins--------------------")
find_package(Getdata)
find_package(Gsl)
find_package(Netcdf)
find_package(CFITSIO)
#find_package(Dmc)
message(STATUS "----------------------------------------------")
else()
message(STATUS "Building plugins depending on 3rd party libraries suppressed")
endif()
message(STATUS)
# React on options
if(kst_release)
set(CMAKE_BUILD_TYPE Release)
else()
set(CMAKE_BUILD_TYPE Debug)
endif()
if(kst_verbose)
set(CMAKE_VERBOSE_MAKEFILE 1)
else()
set(CMAKE_VERBOSE_MAKEFILE 0)
endif()
if(kst_install_prefix)
set(CMAKE_INSTALL_PREFIX ${kst_install_prefix} CACHE PATH "User's choice for install prefix" FORCE)
set(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
else()
set(kst_install_prefix INSTALLED)
set(CMAKE_INSTALL_PREFIX ${kst_install_prefix} CACHE PATH "Kst's default install prefix" FORCE)
endif()
if(NOT kst_install_libdir)
set(kst_install_libdir lib)
endif()
if(NOT kst_install_plugins)
set(kst_install_plugins ${kst_install_libdir}/${kst_binary_name}/plugins)
endif()
if(kst_rpath)
# the RPATH to be used when installing
set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${kst_install_libdir}")
endif()
#path to install the .desktop files
set(kst_install_plugin_desktop_file_path share/services/kst)
if(NOT kst_console)
set(kst_win32 WIN32)
set(kst_qtmain_library ${QT_QTMAIN_LIBRARY})
endif()
if(APPLE AND NOT CMAKE_GENERATOR STREQUAL Xcode)
set(kst_win32 MACOSX_BUNDLE)
endif()
if(APPLE)
set(kst_pch 0 CACHE BOOL "Disable pch on Mac, not supported yet" FORCE)
endif()
if(kst_merge_files)
set(kst_pch 0 CACHE BOOL "Disable pch because we build merged" FORCE)
endif()
if(MSVC)
add_definitions(-D_USE_MATH_DEFINES)
else()
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall")
endif()
if(MSVC_IDE AND kst_edit_cont)
# Enable in Visual Studio
set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /ZI")
if(kst_pch)
# Studio bug:
set(kst_pch 0 CACHE BOOL "Disable pch because of Edit&Continue" FORCE)
endif()
endif()
if(WIN32)
set(kst_debug_postfix d)
endif()
configure_file(${kst_dir}/cmake/config.h.cmake ${CMAKE_BINARY_DIR}/config.h)
include_directories(${CMAKE_BINARY_DIR} ${QT_INCLUDES})
message(STATUS "Build summary----------------------------------")
message(STATUS)
message(STATUS "Version : ${kst_version}")
message(STATUS "Path to source: ${kst_dir}")
message(STATUS "Installation :")
message(STATUS " ${kst_install_prefix}/bin")
message(STATUS " ${kst_install_prefix}/${kst_install_libdir}")
message(STATUS " ${kst_install_prefix}/${kst_install_plugins}")
message(STATUS)
message(STATUS "Options:")
kst_option_list_all()
message(STATUS)
message(STATUS "-----------------------------------------------")
message(STATUS)
add_subdirectory(src)
if(kst_test)
enable_testing()
add_subdirectory(tests)
endif()
if (NOT APPLE)
add_subdirectory(misc)
endif()
# CPack packaging
#
# http://cmake.org/cmake/help/cmake-2-8-docs.html#module:CPack
if(WIN32)
set(CPACK_GENERATOR NSIS ZIP)
set(CPACK_BINARY_ZIP 1)
if (kst_install_prefix)
set(CPACK_NSIS_PACKAGE_NAME ${kst_install_prefix})
endif()
endif()
if (kst_install_prefix)
set(CPACK_PACKAGE_FILE_NAME ${kst_install_prefix}-binary)
set(CPACK_SOURCE_PACKAGE_FILE_NAME ${kst_install_prefix})
else()
set(CPACK_SOURCE_PACKAGE_FILE_NAME Kst-${kst_version})
endif()
set(CPACK_INSTALL_PREFIX "")
set(CPACK_PACKAGE_NAME Kst)
set(CPACK_PACKAGE_EXECUTABLES ${kst_binary_name} Kst2)
set(CPACK_PACKAGE_VENDOR "The Kst Team")
set(CPACK_PACKAGE_VERSION_MAJOR ${kst_version_major})
set(CPACK_PACKAGE_VERSION_MINOR ${kst_version_minor})
set(CPACK_PACKAGE_VERSION_PATCH ${kst_version_patch})
set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Kst 2")
set(CPACK_PACKAGE_DESCRIPTION_FILE ${kst_dir}/README)
set(CPACK_PACKAGE_CONTACT "http://bugs.kde.org}")
set(CPACK_PACKAGE_INSTALL_DIRECTORY "Kst ${kst_version}")
set(CPACK_STRIP_FILES 1)
# cmake bug, problems with the quotes in the gpl, fixed in 2.8.4
set(CPACK_RESOURCE_FILE_LICENSE "${kst_dir}/COPYING")
# sources
set(CPACK_SOURCE_INSTALLED_DIRECTORIES "${kst_dir};/") # http://www.mail-archive.com/cmake@cmake.org/msg33720.html
set(CPACK_SOURCE_GENERATOR TGZ ZIP TBZ2)
# rpm
set(CPACK_SET_DESTDIR "ON")
FILE(READ ${CPACK_RESOURCE_FILE_LICENSE} CPACK_RPM_PACKAGE_LICENSE)
set(CPACK_RPM_PACKAGE_GROUP "Applications/Science")
set(CPACK_RPM_PACKAGE_VENDOR ${CPACK_PACKAGE_VENDOR})
# deb
# This is experimental
# check also for plugin's 3rdparty libraries?
set(CPACK_DEBIAN_PACKAGE_DEPENDS "libqtgui4 (>= 4.4.3-0)")
# Usage
#
# Source only .targz, .tar.bz2, .zip:
# make package_source
#
# Binary .tar.gz and install .sh:
# make package
#
# Binary .deb:
# create : cpack -G DEB --config CPackConfig.cmake
# list : dpkg-deb -c Kst-*.deb
# install: dpkg -i Kst-*.deb
#
# Binary .rpm:
# create : cpack -G RPM --config CPackConfig.cmake
# list : rpm -qlp Kst-*.rpm
# install: rpm -U Kst-*.rpm
# CPack and Ubuntu
# Found this:
# http://www.purplekarrot.net/blog/dputCMake.html
if(APPLE)
# We start from build/bin/kst2.app, all is build into the final bundle folder
# On the mac the pathes to needed shared libraries are hardcoded in the binary/library
# which could be changed by the macro 'fixup_bundle'
# libs which are hardcoded are resolved automatically
# but the plugins must be passed as extra argument because they are not hardcoded in the binary
set(bundle_dir ${kst_build_dir}/bin)
set(contents_dir ${kst_binary_name}.app/Contents)
set(app ${bundle_dir}/${kst_binary_name}.app)
install(DIRECTORY "${QT_PLUGINS_DIR}/imageformats" DESTINATION ${bundle_dir}/${contents_dir}/plugins COMPONENT Runtime)
install(CODE
"file(GLOB qt_plugins \"${bundle_dir}/${contents_dir}/plugins/imageformats/*${CMAKE_SHARED_LIBRARY_SUFFIX}\")
file(GLOB kst_plugins \"${bundle_dir}/${contents_dir}/plugins/*${CMAKE_SHARED_MODULE_SUFFIX}\")
set(libs \${qt_plugins} \${kst_plugins})
include(BundleUtilities)
fixup_bundle(\"${app}\" \"\${libs}\" \"${dir}\") "
COMPONENT RUNTIME)
file(WRITE ${CMAKE_BINARY_DIR}/qt.conf "")
install(FILES ${CMAKE_BINARY_DIR}/qt.conf DESTINATION ${contents_dir}/Resources COMPONENT Runtime)
set(CPACK_GENERATOR DragNDrop)
endif()
include(CPack)
kst-2.0.3/cmake/misc/CMakeLists.txt 000644 001750 001750 00000003215 11544160206 017444 0 ustar 00synth synth 000000 000000 # install runtime files
if(WIN32)
install(FILES
${QT_BINARY_DIR}/QtCore4.dll
${QT_BINARY_DIR}/QtGui4.dll
${QT_BINARY_DIR}/QtXml4.dll
${QT_BINARY_DIR}/QtOpenGL4.dll
${QT_BINARY_DIR}/QtSvg4.dll
DESTINATION bin
CONFIGURATIONS Release)
install(FILES
${QT_BINARY_DIR}/QtCored4.dll
${QT_BINARY_DIR}/QtGuid4.dll
${QT_BINARY_DIR}/QtXmld4.dll
${QT_BINARY_DIR}/QtOpenGLd4.dll
${QT_BINARY_DIR}/QtSvgd4.dll
DESTINATION bin
CONFIGURATIONS Debug)
endif()
if(MINGW)
get_filename_component(MINGW_BIN_PATH ${CMAKE_CXX_COMPILER} PATH)
install(FILES
${MINGW_BIN_PATH}/libgcc_s_dw2-1.dll
${MINGW_BIN_PATH}/mingwm10.dll
DESTINATION bin)
endif()
if(WIN32)
set(color_folder colors)
set(tutorial_folder tutorial)
set(font_folder fonts)
else()
set(color_folder share/config/colors)
set(tutorial_folder share/apps/kst/tutorial)
SET(font_folder share/apps/kst/fonts)
endif()
# install data files
if(UNIX)
if(NOT gyrodata)
configure_file(${kst_dir}/sample_data/GYRODATA+free-width+whitespace+unixEOL+dot-decimal-separator.txt.gz
${CMAKE_BINARY_DIR}/gyrodata.dat.gz COPYONLY)
execute_process(WORKING_DIRECTORY ${CMAKE_BINARY_DIR} COMMAND gunzip gyrodata.dat.gz)
set(gyrodata ${CMAKE_BINARY_DIR}/gyrodata.dat CACHE STRING "gyrodata decompressed")
endif()
endif()
file(GLOB dat_files ${kst_dir}/misc/tutorial/*.dat)
install(FILES ${dat_files} ${gyrodata} DESTINATION ${tutorial_folder})
# install colors
file(GLOB idl_files ${kst_dir}/misc/IDL*)
install(FILES ${idl_files} DESTINATION ${color_folder})
#install fonts
if(UNIX)
file(GLOB fonts ${kst_dir}/misc/fonts/*.gz)
install(FILES ${fonts} DESTINATION ${font_folder})
endif()
kst-2.0.3/cmake/config.h.cmake 000644 001750 001750 00000000405 11544160206 016444 0 ustar 00synth synth 000000 000000
#ifndef KST_CONFIG_H
#define KST_CONFIG_H
// obligatory flags
//#define QT_NO_STL
//#define QT_NO_KEYWORDS
#define KSTVERSION "${kst_version}"
#define KST_INSTALL_LIBDIR "${kst_install_libdir}"
#define KST_INSTALL_PLUGINS "${kst_install_plugins}"
#endif
kst-2.0.3/cmake/src/libkstmath/CMakeLists.txt 000644 001750 001750 00000000305 11544160206 021437 0 ustar 00synth synth 000000 000000 kst_init(${kst_binary_name} math)
kst_files_find(src/libkstmath)
kst_dont_merge(eparse.cpp escan.cpp fftsg_h.c)
kst_include_directories(core math)
kst_add_library(SHARED)
kst_link(${libcore})
kst-2.0.3/cmake/src/libkstapp/CMakeLists.txt 000644 001750 001750 00000001213 11544160206 021265 0 ustar 00synth synth 000000 000000 kst_init(${kst_binary_name} app)
kst_files_find(src/libkstapp)
kst_include_directories(core math widgets)
set(AUTHORS ${kst_dir}/AUTHORS)
set_source_files_properties(${AUTHORS} PROPERTIES GENERATED TRUE HEADER_FILE_ONLY TRUE)
file(READ ${AUTHORS} data)
string(REPLACE "\n" ";" kst_authors ${data})
file(WRITE ${CMAKE_BINARY_DIR}/authors.h.tmp "static const char* kst_authors = \"${kst_authors}\";\n")
execute_process(COMMAND ${CMAKE_COMMAND}
-E copy_if_different
${CMAKE_BINARY_DIR}/authors.h.tmp ${CMAKE_BINARY_DIR}/authors.h)
kst_add_library(STATIC ${CMAKE_BINARY_DIR}/authors.h ${AUTHORS})
kst_link(${libcore} ${libmath} ${libwidgets})
kst-2.0.3/cmake/src/plugins/CMakeLists.txt 000644 001750 001750 00000004455 11544160206 020770 0 ustar 00synth synth 000000 000000
kst_init_plugin(src/plugins)
kst_add_plugin(dataobject bin)
kst_add_plugin(dataobject chop)
kst_add_plugin(dataobject linefit)
kst_add_plugin(dataobject lockin)
kst_add_plugin(dataobject phase)
kst_add_plugin(dataobject shift)
kst_add_plugin(dataobject statistics)
kst_add_plugin(dataobject syncbin)
kst_add_plugin(dataobject crossspectrum)
kst_add_plugin(dataobject differentiation)
kst_add_plugin(dataobject effectivebandwidth)
kst_add_plugin(dataobject genericfilter)
kst_add_plugin(filters cumulativesum)
kst_add_plugin(filters despike)
kst_add_plugin(filters differentiation)
if(gsl)
include_directories(${GSL_INCLUDE_DIR})
macro(kst_add_gsl_plugin dir name)
kst_add_plugin(${dir} ${name})
kst_link(${GSL_LIBRARIES})
endmacro()
kst_add_gsl_plugin(dataobject/convolution convolve)
kst_add_gsl_plugin(dataobject/convolution deconvolve)
kst_add_gsl_plugin(dataobject/correlation autocorrelation)
kst_add_gsl_plugin(dataobject/correlation crosscorrelation)
kst_add_gsl_plugin(dataobject/interpolations akima)
kst_add_gsl_plugin(dataobject/interpolations akimaperiodic)
kst_add_gsl_plugin(dataobject/interpolations cspline)
kst_add_gsl_plugin(dataobject/interpolations csplineperiodic)
kst_add_gsl_plugin(dataobject/interpolations linear)
kst_add_gsl_plugin(dataobject/interpolations polynomial)
kst_add_gsl_plugin(dataobject noiseaddition)
kst_add_gsl_plugin(dataobject periodogram)
kst_add_gsl_plugin(filters butterworth_bandpass)
kst_add_gsl_plugin(filters butterworth_bandstop)
kst_add_gsl_plugin(filters butterworth_highpass)
kst_add_gsl_plugin(filters butterworth_lowpass)
kst_add_gsl_plugin(fits exponential_unweighted)
kst_add_gsl_plugin(fits exponential_weighted)
kst_add_gsl_plugin(fits gaussian_unweighted)
kst_add_gsl_plugin(fits gaussian_weighted)
kst_add_gsl_plugin(fits gradient_unweighted)
kst_add_gsl_plugin(fits gradient_weighted)
kst_add_gsl_plugin(fits kneefrequency)
kst_add_gsl_plugin(fits linear_unweighted)
kst_add_gsl_plugin(fits linear_weighted)
kst_add_gsl_plugin(fits lorentzian_unweighted)
kst_add_gsl_plugin(fits lorentzian_weighted)
kst_add_gsl_plugin(fits polynomial_unweighted)
kst_add_gsl_plugin(fits polynomial_weighted)
kst_add_gsl_plugin(fits sinusoid_unweighted)
kst_add_gsl_plugin(fits sinusoid_weighted)
endif()
kst-2.0.3/cmake/src/CMakeLists.txt 000644 001750 001750 00000000413 11544160206 017275 0 ustar 00synth synth 000000 000000 add_subdirectory(libkst)
add_subdirectory(libkstmath)
add_subdirectory(widgets)
add_subdirectory(libkstapp)
add_subdirectory(kst)
add_subdirectory(datasources)
if(kst_dataobjects)
add_subdirectory(plugins)
endif()
#add_subdirectory(d2asc)
#add_subdirectory(d2d)
kst-2.0.3/cmake/src/datasources/CMakeLists.txt 000644 001750 001750 00000001635 11544160206 021621 0 ustar 00synth synth 000000 000000
kst_init_plugin(src/datasources datasource)
if(MSVC OR MINGW)
add_definitions(-DKST_USE_KST_ATOF)
endif()
if(UNIX)
# speedup on Linux x2.7
add_definitions(-DKST_USE_KST_ATOF)
endif()
kst_add_plugin(. ascii)
kst_add_plugin(. qimagesource)
kst_add_plugin(. sampledatasource)
if(getdata)
include_directories(${GETDATA_INCLUDE_DIR})
kst_add_plugin(. dirfilesource)
kst_link(${GETDATA_LIBRARIES})
endif()
if(cfitsio)
include_directories(${CFITSIO_INCLUDE_DIR})
kst_add_plugin(. fitsimage)
kst_link(${CFITSIO_LIBRARIES})
endif()
if(healpix)
kst_add_plugin(. healpix)
endif()
if(lfioo)
kst_add_plugin(. lfiio)
endif()
if(netcdf)
include_directories(${NETCDF_INCLUDE_DIR})
kst_add_plugin(. netcdf)
kst_link(${NETCDF_LIBRARIES})
endif()
if(planckIDEF)
kst_add_plugin(. planckIDEF)
endif()
if(dmc)
include_directories(${DMC_INCLUDE_DIR})
kst_add_plugin(. dmc)
#kst_link(${DMC_LIBRARIES})
endif()
kst-2.0.3/cmake/src/libkst/CMakeLists.txt 000644 001750 001750 00000000525 11544160206 020571 0 ustar 00synth synth 000000 000000 kst_init(${kst_binary_name} core)
kst_files_ignore(stdinsource timezones)
if(WIN32 OR APPLE OR ${CMAKE_SYSTEM_NAME} MATCHES "FreeBSD")
kst_files_ignore(sysinfo psversion)
else()
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -lrt")
endif()
kst_files_find(src/libkst)
kst_dont_merge(sysinfo.c psversion.c)
kst_add_library(SHARED)
kst_link()
kst-2.0.3/cmake/src/kst/CMakeLists.txt 000644 001750 001750 00000003453 11544160206 020105 0 ustar 00synth synth 000000 000000 kst_init(${kst_binary_name} "")
kst_files_ignore(main-vld)
kst_files_find(src/kst)
if(WIN32)
if(MINGW)
add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/kst_icon.o
COMMAND windres.exe -I${CMAKE_CURRENT_BINARY_DIR}
-i${kst_dir}/src/kst/kst_icon.rc
-o ${CMAKE_CURRENT_BINARY_DIR}/kst_icon.o)
set(rc_file ${CMAKE_CURRENT_BINARY_DIR}/kst_icon.o)
else()
set(rc_file ${kst_dir}/src/kst/kst_icon.rc)
endif()
endif()
kst_add_resources(src/images/images.qrc)
kst_find_info_files(KstCMakeFiles ${kst_dir}/cmake/*)
kst_find_info_files(KstCMakeFiles ${kst_dir}/cmake/modules/*)
kst_add_info_files(KstInfoFiles
${kst_dir}/INSTALL
${kst_dir}/NEWS
${kst_dir}/README)
kst_include_directories(app)
kst_add_executable(${kst_win32} ${rc_file})
kst_link(${libcore} ${libmath} ${libapp} ${libwidgets})
kst_install_executable()
if(UNIX AND NOT APPLE)
set(man ${CMAKE_BINARY_DIR}/${kst_binary_name}.1)
configure_file(${kst_dir}/src/kst/kst.1.txt ${man})
install(CODE "execute_process(COMMAND gzip ${man})")
set_source_files_properties(${man}.gz PROPERTIES GENERATED TRUE)
install(FILES ${man}.gz DESTINATION share/man/man1)
set(k ${kst_dir}/src/kst)
install(FILES ${k}/kstplugin.desktop
${k}/kstdatasourceplugin.desktop
${k}/kstdataobjectplugin.desktop
${k}/kstbasicplugin.desktop
${k}/kstfilter.desktop
${k}/kstextension.desktop
DESTINATION share/servicetypes/kst)
install(FILES ${k}/kst.desktop DESTINATION share/applnk/Graphics)
install(FILES ${k}/kstui.rc DESTINATION share/apps/kst)
install(FILES ${k}/x-kst.desktop DESTINATION share/mimelink/application)
install(FILES ${k}/kst.desktop DESTINATION share/applications)
endif()
kst-2.0.3/cmake/src/d2asc/CMakeLists.txt 000644 001750 001750 00000000245 11544160206 020274 0 ustar 00synth synth 000000 000000 kst_init(d2asc)
kst_files_find(src/d2asc)
kst_include_directories(core math)
kst_add_executable()
kst_link(${libcore} ${libmath})
kst_install_executable()
kst-2.0.3/cmake/src/d2d/CMakeLists.txt 000644 001750 001750 00000000237 11544160206 017752 0 ustar 00synth synth 000000 000000 kst_init(d2d "")
kst_files_find(src/d2d)
kst_include_directories(core math)
kst_add_executable()
kst_link(${libcore} ${libmath})
kst_install_executable()
kst-2.0.3/cmake/src/widgets/CMakeLists.txt 000644 001750 001750 00000000243 11544160206 020744 0 ustar 00synth synth 000000 000000 kst_init(${kst_binary_name} widgets)
kst_files_find(src/widgets)
kst_include_directories(core app math)
kst_add_library(SHARED)
kst_link(${libcore} ${libmath}) kst-2.0.3/gdb-kst 000755 001750 001750 00000000160 11544160206 014146 0 ustar 00synth synth 000000 000000 #!/bin/sh
cd `dirname $0`
export SCRIPTDIR=$PWD
export BUILDDIR=$PWD/build
gdb --args $BUILDDIR/bin/kst "$@"
kst-2.0.3/NEWS 000644 001750 001750 00000000065 11544160206 013370 0 ustar 00synth synth 000000 000000 For news, see the kst web page
http://kst.kde.org/
kst-2.0.3/devel-docs/notes/tool_mode_changes 000644 001750 001750 00000006320 11544160206 021442 0 ustar 00synth synth 000000 000000 Layout Mode comments: (July 28, 07)
Overall:
Lets copy inkscape's UI as much as is reasonable. BUT: remember, we are
annotating plots, not making icons!
-in layout mode, we need a toolbar to select the various tools.
Handles:
-need mouseover feedback on handles (inkscape changes colours)
-need feedback on potential selection. Inkscape uses mouse feedback,
but since most objects will over a plot, this is mostly useless. I think
showing ghost handles would be better.
-Handle dimensions should be fixed and should not depend on window/object/
parent size.
(It could be cool to have the the size fixed relative to the screen size.)
-Handles should lie outside the object so that they are accesible with 0
size objects (eg, horizontal line).
-Handles need to have some indication what they are/do (like inkscape).
-to get to rotate mode, you have to click twice, which is too much like
a double click (which calls up the properties dialog). So, get rid
of double click to properties dialog. Instead get it from the rmb or
from button 2.
-On resize, you should be able flip through zero to mirror the object.
This is especially important for lines.
-Sometimes clicking on an object does not bring up the handles.
Is this a bug, or just a different mode?
Line Properties:
-By default, line properties should depend on the size (width + height) of
the page/TopLevelView/Window and should not depend on the aspect ratio of
the object, or its parent or the TLV. This includes:
-line widths
-dash dimensions
-arrow dimensions
-Ends of wide lines - (should be always perpendicular to line)
so,
-resizing an object and not the window should not change its line
widths. NOTE: this is not the same behavior as inkscape.
-The vertical and horizontal lines of a box should always be equal
regardless of any resizing.
-For 2.x, we should consider a per-object option to allow the line properties
to be a function of the parent size, rather than the TLV size.
-Line property units should be 'points, if printed to US Letter'
Aspect ratio
-All objects except lines should have a 'preserve aspect ratio' option.
-Fonts and Pictures should default to having this set.
-All others should default to this unset.
-When it is set, changing the aspect ratio of the object's parent or TLV will
not change the aspect ratio of the objects
-When it is set, moving the grab boxes should uniformly scale the object
(but not Line Properties).
-When it is set, rotations need to be in display space, to preserve
relative angle.
SO:
-rectangles stay rectangles
-fonts don't get distorted
-When it is not set, rotations are in the (0-1, 0-1) space, so objects
will only preserve their apparent aspect ratio if the TLV is square.
Object Specific changes:
Labels:
-To create a lable, click to location, which pops up the dialog (same as 1.4)
Apply/OK on dialog draws the label. In the first instance, we don't need
to support in-place text editing.
Dialogs:
-Inkscape uses multiple dialogs to edit different properties of an object.
We should not. Use tabbed dialogs instead.
-They need to support everything the 1.4 dialogs support.
kst-2.0.3/devel-docs/using_git 000644 001750 001750 00000002077 11544160206 016636 0 ustar 00synth synth 000000 000000 Using Git as subversion client
http://git-scm.com/
(Newer packages for Ubuntu:
http://ppa.launchpad.net/pdoes/ppa/ubuntu karmic main)
Set up git repository, done only once
--------------------------------------
Init your git repository with the svn path
git svn init svn+ssh://YOU_USERNAME@svn.kde.org/home/kde/branches/work/kst/portto4
Get an old revision as starting point (git slang: basepoint)
e.g http://mail.kde.org/pipermail/kst/2008-January/015217.html
git svn fetch -r768342
(without the revision it starts checking for commit at revsion 100,
but also only getting all changes from january takes a while)
Update
------
Update your local clone
git svn fetch
Update your local branch 'master' (git slang: move basepoint of master
to HEAD of the fetched data)
git checkout master
git svn rebase
History
-------
Browse history offline with a git-GUI gitk, gitg, qgit, ...
Commiting
----------
Commit your changes to your local repository
git commit "message" -a
Commit to public svn repository
git svn dcommit
kst-2.0.3/devel-docs/general_1.x/branches.txt 000644 001750 001750 00000001447 11544160206 021354 0 ustar 00synth synth 000000 000000 Branch: svn.kde.org/home/kde/branches/kst/1.1/
Description: Stable branch for Kst 1.1.x
Branch: svn.kde.org/home/kde/branches/kst/1.2/
Description: Stable branch for Kst 1.2.x
Branch: svn.kde.org/home/kde/branches/kst/hfi_calib/
Description: Branch for use by HFI. Restricted to George only for commits.
Branch: svn.kde.org/home/kde/branches/kst/branches/work/kst/*
Description: Branches for development of new features outside of trunk.
You make a branch with:
svn cp https://svn.kde.org/home/kde/trunk/extragear/graphics https://svn.kde.org/home/kde/branches/work/kst/
You can then check out your branch from that URL. It's best to remove the parts
of the branch that you do not need. Simply check it out with:
svn co https://svn.kde.org/home/kde/branches/work/kst/
kst-2.0.3/devel-docs/general_1.x/mimetypes.txt 000644 001750 001750 00000002143 11544160206 021575 0 ustar 00synth synth 000000 000000 List of mimetypes we provide and their definitions:
application/x-kst:
A Kst XML file in full
application/x-kst-fragment:
A Kst XML fragment that can be read and interpreted, but does not describe a
full Kst session. Unimplemented.
application/x-kst-plot-list:
A list of plot names encoded as a qstringlist. Used primarily for drag and
drop in the plot dialog.
application/x-kst-plot-names:
A list of plot names encoded as a qstringlist, preceded by a window. Used for
drag and drop of plots between windows in Kst 1.1.0 only. DEPRECATED
application/x-kst-legend:
A plot legend. Contains the window name, the plot name, and the hotspot.
DEPRECATED
application/x-kst-label-number:
A plot label. Contains the window name, the plot name, the label number in the
internal list, and the hotspot. DEPRECATED
application/x-kst-plots:
Unimplemented, reserved for plot dragging.
Do not implement support for drag and drop or copy and paste for the deprecated
mimetypes in any new applications. They are almost entirely useless there, and
these types will be removed from Kst starting in version 1.2.0.
kst-2.0.3/devel-docs/general_1.x/datatypes.txt 000644 001750 001750 00000003752 11544160206 021566 0 ustar 00synth synth 000000 000000
Kst contains types, just as a typical computer application. In C++, there
are primitive types (POD) and derived types (classes). In Kst, we have the
following categorization:
Primitive Types Derived Types Interpretations
-------------------------------------------------------------------------
KstScalar KstPSD KstVCurve
KstString KstEquation KstImage*
KstVector KstHistogram
KstRVector KstPlugin
KstAVector KstCSD
KstSVector
KstMatrix*
KstRMatrix
KstAMatrix
KstSMatrix
KstMatrix and KstImage are presently wrong in Kst. They are both derived
types, and yet one represents primitive underived data (though it is not
implemented that way), and the other is used directly to interpret that
data as a visualization.
Primitive types can be created by the user, or loaded from storage. The
present data loading mechanism is flawed in that it only supports loading
one type of data from disk: vectors. KstDataSource needs to be expanded
with a keyed plugin mechanism and needs to drop binary compatibility
issues [-internally- -only-] so that it can be extended to support these
other primitive types. This key is implemented in the development code.
The next step is to create Kst?Matrix classes which behave as close as
possible to the same way Kst?Vector does, with an interface as close as
possible to that of Kst?Vector. Once this is done, the KstDataSource
interface can be extended to support loading them (as well as all other
primitive types). The Matrix dialog will become an equivalent to the
Vector dialog.
Note that Matrix needs to be a primitive type internally too. It should
not use KstVector.
After matrices are renovated, KstImage needs to be converted into a
KstBaseCurve and adjusted somewhat to be a generic curve with a matrix
for storing data. It is desired at some point to be able to render all
sort of different image formats easily with this class. This change,
however, depends on changes to Kst2DPlot to an extent, and should wait
for those changes. (they are minor)
kst-2.0.3/devel-docs/general_1.x/testplan.txt 000644 001750 001750 00000022322 11544160206 021414 0 ustar 00synth synth 000000 000000 Kst Test Plan
=============
This is a test plan designed to test basic functionality of the entire Kst
application as a whole, from a user perspective. Only certain combinations of
certain actions are tested.
In the following steps, each action should produce an expected result. Results
deviating from the expected results should be recorded. Results not deviating
from the expected result should be recorded as well.
The following perl script is used:
datagenerator.pl
under kst/tests/
I. Compiling and Installing
---------------------------
1. Make sure CFITSIO and GSL libraries are installed.
2. Download and untar the Kst source.
3. Do the following:
./configure --prefix=`kde-config --prefix`
make
make install
Expected Result: Kst is installed.
4. Run Kst:
kst
Expected Result: Kst starts. Main window is shown.
II. Basic Functionality
-----------------------
0. Run:
datagenerator.pl testdata
Wait 30 seconds. Terminate execution of datagenerator.pl.
1. Select Data->Data Wizard. Browse to "testdata". Click Next.
Expected Result: 2nd window of Data Wizard is displayed. 4 fields should be
selectable.
2. Type * in the Search box.
Expected Result: All fields should be highlighted.
3. Remove * from the Search box and highlight fields 2, 3, and 4. Click Check
Selected.
Expected Result: Fields 2,3,4 should be checked. Field 1 should not
be checked.
4. Check the Read to end checkbox. Select XY and Power Spectrum for Plot Type.
Click Next. Select 1 plot per curve. Click Finish.
Expected Result: 6 plots are displayed.
5. Drag a rectangle on a plot.
Expected Result: Plot zooms in.
6. Hold down shift and drag a rectangle on a plot.
Expected Result: Plot zooms in on y axis only.
7. Hold down ctrl and drag a rectangle on a plot.
Expected Result: Plot zooms in on x axis only.
8. Hold cursor over a plot and hit left, right, up, down arrow keys.
Expected Result: Plot scrolls left, right, up, down respectively.
9. Right-click on a plot and select Edit->(Curve Name). Change Y Axis Vector
and change curve colour. Click Apply Edits.
Expected Result: Plot changes to reflect new vector and colour.
10. Select Data->Data Manager. Click Vector button under New: and choose field
2. Click Apply As New. Click Close.
Expected Result: New vector V5-2 should be created.
11. Click Curve. Select V0-INDEX as X axis vector and V1-2 as Y axis vector.
Click Apply As New. Click Close.
Expected Result: New Curve and plot are created.
12. Click Equation. Enter the equation:
[V1-2]+SIN([V2-3])
Click Apply As New. Click Close.
Expected Result: New Equation is created.
13. Click Histogram. Select V3-4 as the vector. Click Apply As New. Click
Close.
Expected Result: New Histogram is created.
14. Click Power Spectra. Select V1-2 as the vector. Click Apply As New. Click
Close.
Expected Result: New Power Spectrum is created.
15. Click Plugin. Select Fit polynomial as the plugin. Select V0-INDEX as the
X Array and V1-2 as the Y Array. Enter 2 as the order. Click Apply As New
and then Close.
Expected Result: New Plugin is created.
16. Expand the listing for the new plugin in Data Manager and right-click on
...-Y Fitted. Select Make Curve. Click Apply As New and click Close.
Expected Result: New Curve showing the fit is created.
17. Click Event. Select V1-2 as the vector. Append >0 to the expression.
Select Log As and choose Warning. Click Apply As New and click Close.
Expected Result: New Event is created.
18. Right-click C2-V2-3 and choose Remove From Plot->(plot name). Right-click
PSD3-V2-3 and choose Remove From Plot->(plot name). Click the Purge button.
Expected Result: C2-V2-3, PSD3-V2-3 and V2-3 are removed from Data Manager.
19. Close Data Manager. Goto Help->Debug Kst. Select Log tab.
Expected Result: There are 13 Event Monitor Warnings.
20. Close Kst Debug Dialog. Select Plots->Label Editor. Click on any plot.
Expected Result: Label Editor dialog appears.
21. Enter arbitrary label text. Select a font and enter 30 for rotation. Click
OK.
Expected Result: Label is created, rotated 30 degrees clockwise.
22. Drag the label.
Expected Result: Label moves to new location.
23. Click on the label.
Expected Result: Label Editor Dialog appears with settings for this label.
24. Click Ok. Select Plots->Layout Mode. Drag the plots around and resize by
dragging edges of the plots.
Expected Result: Plots are rearranged and resized.
25. Select Plots->Layout Mode. Select Plots->XY Mouse Zoom.
26. Select File->Print. Click Print.
Expected Result: Current window is printed in landscape orientation, with
footer.
27. Select File->Save Vectors to Disk. Select V3-4 and click Save. Enter a
filename and click Save, then Close. Select File->Export to Graphics File.
Select a Save Location and click Save Once.
Expected Result: Vector and Graphics files are saved to specified locations.
28. Right-click and plot and select Delete.
Expected Result: The plot is removed from window.
29. Select File->New Window. Enter 1234 and click OK. Select File->New Window.
Enter abcdef and click OK.
Expected Result: Two new windows are created.
30. Select Window->MDI Mode->Toplevel.
Expected Result: Windows are arranged in Toplevel mode.
31. Select Window->MDI Mode->Childframe. Select Window->Tile...->Tile
Non-overlapped
Expected Result: Windows are arranged in Childframe mode, tiled.
32. Select Window->MDI Mode->Tab Page Mode.
Expected Result: Windows are arranged in Tab Page mode.
33. Select Window->MDI Mode->IDEAl mode.
Expected Result: Windows are arranged in IDEAl mode.
34. Select File->Save. Save file to a location. Select File->New
Expected Result: All windows are cleared.
35. Select Data->Data Manager.
Expected Result: No data objects are present.
36. Select File->Quit.
Expected Result: Kst exits.
37. Start Kst. Select File->Open. Browse to file saved in step 34.
Expected Result: All windows, plot layouts, data objects saved are open.
38. Select Settings->Plugins. Highlight Autocorrelation and click Remove, then
Yes. Highlight Chop and click Remove, then Yes. Highlight Linefit and click
Remove, then Yes.
Expected Result: Autocorrelation, Chop, Linefit are removed from list.
39. Click Rescan.
Expected Result: Autocorrelation, Chop, Linefit are added to list.
40. Click Close. Select File->Quit.
Expected Result: Plugin Manager is closed. Kst exits.
41. Delete testdata.
Streaming Data
==============
0. During the following steps, note any slowless or strange behaviour.
1. Run:
datagenerator.pl teststream
2. Start Kst. Select Data->Data Manager. Click Vector. Browse to teststream
for File name, select Field 1. Check Read to End. Click Apply as New.
Select Field 2. Check Read to End. Click Apply as New. Click Close.
Expected Result: Vectors V1-1 and V2-2 are created.
3. Click Curve. Select V1-1 for X axis vector, V2-2 for Y axis vector. Click
New... under Curve Placement. Type 1234 and click OK. Check Place in new
plot. Click Apply as New.
Expected Result: New Curve is created in new window and plot.
4. Watch plot for 10 seconds.
Expected Result: Plot updates as new data is written.
5. Select Range->Pause. Watch plot for 10 seconds.
Expected Result: Plot does not update.
6. Select Range->Read from End. Watch plot for 10 seconds.
Expected Result: Plot updates with new data.
7. Select Plots->XY Mouse Zoom. Draw a rectangle on plot. Watch plot for 10
seconds.
Expected Result: Plot zooms in to rectangular area, does not update.
8. Right-click on plot, select Zoom->Zoom Maximum. Watch plot for 10 seconds.
Expected Result: Plot updates with new data.
9. Select Plots->Y Mouse Zoom. Draw rectangular area on plot. Watch plot for
10 seconds.
Expected Result: Plot zooms in on y axis, plot continues to update.
10. Select Plots->X Mouse Zoom. Draw rectangular area smaller than current plot
size. Watch plot for 10 seconds.
Expected Result: Plot zooms in on y axis, plot does not update.
11. Right-click on plot, select Zoom->Zoom Maximum. Click plot and hit right
arrow key 5 times. Watch plot for 10 seconds.
Expected Result: Plot scrolls to right, revealing blank area. Plot updates
and draws curves to blank area.
12. Right-click on plot, select Zoom->Zoom Maximum. Select Plots->Edit Plots.
Select Limits tab. Under X Axis, choose AC: Range, and enter 9000. Click
Apply Edits and click Close. Watch plot for 10 seconds.
Expected Result: X axis changes to 9000 length, plot updates, lower x axis
value updates accordingly to keep 9000 length.
13. Select Data->Edit Equation. Create equation:
[V1-2]*5
Select V0-1 for Use Existing Vector under Independent Variable. Select Place
in new plot under Curve Placement, click Apply as New.
Expected Result: New curve and plot is created,
14. Watch plot for 10 seconds.
Expected Result: New curve and plot updates simultaneously with original
plot.
15. Select File->Quit, click No.
Expected Result: Kst exits.
16. Terminate execution of datagenerator.pl, delete teststream.
kst-2.0.3/devel-docs/general_1.x/plotmarkers.txt 000644 001750 001750 00000002403 11544160206 022123 0 ustar 00synth synth 000000 000000 For plot marking:
=================
- use Alt-Left Click to created a plot marker at the current position
- use a vertical dotted foreground-colour line to mark the plot.
- all other zooming/data mode actions are still available.
Add to Plot Dialog
------------------
- plot markers will be part of plots, not curves.
- have a new tab on the Plot Dialog called Markers
- on the tab will be a list of plot markers
(probably in x-coordinate form)
- underneath/beside the list of plot markers will be 3 buttons:
- Add (to manually add a plot marker by entering the value)
- Remove (this will remove selected plot marker(s))
- Remove All
Add to Plot Context Menu
------------------------
- add a separater to the bottom of the Scroll submenu in the context menu
- underneath the separater, add two entries:
- Next Plot Marker
- Previous Plot Marker
- suggested shortcuts - Alt+Right arrow/Alt+Left arrow, PgUp/PgDown,...
- moving to plot markers is a scrolling action, it will not change the
zoom "level"
Additional Details
------------------
- there will be public functions for adding, removing, and retrieving plot
markers from plots (event monitors could use these to add markers,
given that a plot is specified to be associated with the event).
kst-2.0.3/devel-docs/general_1.x/objectnaming.txt 000644 001750 001750 00000011613 11544160206 022223 0 ustar 00synth synth 000000 000000 All data objects (objects derived from KstObject) should be globally accessible
from a hierarchical namespace. The general idea is to change tags to be a path
instead of a simple name.
A full path should uniquely specify a particular object in the hierarchy. We
use separate hierarchies for different object types to allow, for example,
a vector and a string to have the same name.
The relationship of a KstObject being below another KstObject in the hierarchy
means that the parent object CREATED the child object. Note that this is not
the same thing as data PROVIDERS, which form a dependency graph (perhaps with
cycles) rather than a tree. For example, a PSD created with the PSD button in
the Data Manager is placed after its source vectors in the provider graph, but
is a Level 1 object (i.e. not below its source vectors) in the naming
hierarchy.
Level 0
-------
An implied single root with no name. It is probably better to show Level 1
objects as multiple roots and have no Level 0 object.
Level 1
-------
- Providers/Data Sources.
- Global constants. A CONSTANTS namespace can be used (maybe with a full
hierarchy of constant types).
- Global (user-created) KstPrimitives
- e.g. generated KstVector, KstMatrix
- user-created KstDataObjects
- curves, equations, power spectra, etc.
Level 2
-------
- Data vectors read from a data source (e.g. KstVector::tagName()). These names
will not collide as long as there are unique names in each data source.
- Data source metadata strings, scalars (author, dataset description,
numFields, etc.)
Level 3
-------
- KstObjects generated from level 2 objects (e.g. KstScalars for min, max,
etc.).
- Data object metadata strings, scalars (units, field description, etc.)
In labels, one can use the full path to specify a field (e.g.
[DataSource1/Field1/max]), or start with any globally-unique name and go from
there, which is compatible with the current model (e.g. [Field1/max]). Using
'/' as a path separator allows compatibility with existing .kst files, but will
cause conflicts with datasources using '/' within field names. For now, I'm
converting '/' to '-'.
In addition to the global lists of scalars, vectors, matrices, etc., we can
view the data as a tree of KstObjects:
- DataSource1
\
+ Field1
+ Field2
- DataSource2
\
+ Field1
- Field1-2
\
- min
- max <========== [DataSource2/Field1-2/max] or [Field1-2/max]
- Field2
\
- min
- max
- units
- description
+ Field3
- Field4
\
- min
- max
- units
- description
We have separate trees to show only scalars or strings (or whatever) in an
organized way.
IMPLEMENTATION DETAILS
======================
Instead of tags being QStrings, they are now KstObjectTag objects. These
objects contain a QString tag (the last part of the hierarchical tag) and a
QStringList context. The static constant KstObjectTag::globalTagContext
represents global tags (i.e. Level 1). KstObjectTag::constantTagContext
represents a namespace for constants.
For an empty tag in the global namespace, use KstObjectTag::invalidTag. Unless
otherwise specified, the context is assumed to be the global context.
Display Tags
------------
In situations where we display a flat list of object tags (i.e. the primitive
selector comboboxes), we can use display tags. Inside a KstObjectTag there are
two variables: _minDisplayComponents and _uniqueDisplayComponents.
_minDisplayComponents is the minimum number of path components used to form the
display tag. It is set by the user and has a default value of 1. When a tag is
created in the context of another tag, the default value takes one components
of the context tag.
_uniqueDisplayComponents is the number of path components needed to ensure that
the display tag is unique. It is kept up-to-date by the KstObjectCollection
containing the KstObject.
The display tag is formed by taking the last MAX(_minDisplayComponents,
_uniqueDisplayComponents) components of the full tag.
e.g.:
These 4 scalars exist in the system:
- The global constant CONST_PI. The full tag is "CONSTANTS/CONST_PI". The
display tag is "CONST_PI".
- The Max scalar for field GYRO1 in datasource DS-dirfile1. The full tag is
"DS-dirfile1/GYRO1/Max". Since the tag was created in the context of the
GYRO1 vector's tag (DS-dirfile1/GYRO1), _minDisplayComponents is 2. The
display tag is "GYRO1/Max".
- The Max scalar for field GYRO2 in datasource DS-dirfile1. The full tag is
"DS-dirfile1/GYRO2/Max". Again, _minDisplayComponents is 2. Since there
is also a GYRO2 vector from datasource DS-dirfile2,
_uniqueDisplayComponents is 3 (since "GYRO2/Max" is not unique).
Therefore, the display tag is "DS-dirfile1/GYRO2/Max".
- The Max scalar for field GYRO2 in datasource DS-dirfile2. The full tag is
"DS-dirfile2/GYRO2/Max". The display tag is "DS-dirfile2/GYRO2/Max".
The flat list of scalars will be:
CONST_PI
DS-dirfile1/GYRO2/Max
DS-dirfile2/GYRO2/Max
GYRO1/Max
kst-2.0.3/devel-docs/general_1.x/datamodel.txt 000644 001750 001750 00000001265 11544160206 021517 0 ustar 00synth synth 000000 000000
A Kst session consists of a data model along with a graphical representation of
some or all of that data model. The data comes from various places known as
data sources. A data source is a file, network, or other resource that provides
one or more primitives. A primitive is (presently) a string, scalar, vector or
matrix. These can be composed with mathematical algorithms by a data object.
Data objects also output one or more primitives. Primitives can then be
associated as relations, such as a curve. Relations and primitives can then be
used in graphical representations known as views and view items.
Dialogs and wizards are used to hide these representations from the user.
kst-2.0.3/devel-docs/general_1.x/memory.txt 000644 001750 001750 00000007462 11544160206 021102 0 ustar 00synth synth 000000 000000
1) Allocation
malloc() and realloc() are defined to return null pointers in some cases and
this should be tested for. In particular, we need to test for it when we do
big allocations. However we may not always prevent bad situations like this.
Actually, in most cases we probably won't. This is because Linux will
allocate memory to us even when it's not *really* available, and the machine
will go into "swap hell" or the app will be killed by the kernel. Linux is
the main platform for Kst so it is the primary concern. This behaviour is
actually ideal as well, since OOM is generally quite uncommon now, and many
apps allocate more memory than they really need. We are a special case
and we really do use lots of memory.
As a C++ application, we use the C++ allocator whenever possible. For data
vectors, we use malloc() and realloc(), and checking for failed allocations is
important since users may tried to load in data so huge that it can't possibly
be dealt with. Unfortunately it is probably more likely that the user loads
in enough to go into heavy swap but not enough to actually fail the malloc.
Therefore we have code on Linux that checks the system memory and tries to
guess if we will enter this situation. If so, the malloc is denied. You
must use the Kst malloc replacement in order to get this behaviour. In
general malloc() is deprecated and discouraged in Kst.
C++ objects (widgets, containers, other classes) are allocated with the C++
allocator in Kst. That is, Foo *foo = new Foo;. The C++ allocator has one
of two behaviours when allocations fail:
1) throw an exception
2) return null
We don't use exceptions in Kst, so 1 is not suitable. By default g++ doesn't
do 2 so it is not suitable at this time. Furthermore, even if we did start
using exceptions or hardcoded the g++ flags in the makefile to do 2, we still
would crash. Here's why:
It is at least 50% likely that this call will fail in a place that guarantees
a crash:
QListView *l = new QListView(this);
The reason is that internally, it uses [at least one] "d-pointer" which is
allocated without checking the return code. If an exception is thrown, we
don't really know where it failed, and it's likely we will crash due to null
or dangling pointers deep inside one of these classes. If null is returned,
it's not checked in Qt and it's likely that it will crash since it assumes
that the allocation succeeded. Furthermore, these allocations are generally
small, so if they fail, it is because the OS [being most likely Linux] is so
far into swap or out of memory that it is doomed to fail no matter what we do,
including trying to recover, save data, or notify the user. We're just plain
toast at this point. Not only that, but we are multithreaded and we have no
mechanism to be able to prevent those other threads from stomping us out of
existance too.
Therefore, code that checks for null return from operator new is just adding
extra indent and making the code messy and complicated for no gain. In most
cases, Kst will be horribly inconsistent internally if we do check for null
because we just don't expect this anywhere in the ~70,000 lines of code we
have so far.
Finally, it's important to note that failed operator new is exceedingly rare
in the KDE world. Practice shows that there is no tangible gain in checking
for this case, and more time should be spent making the code more stable in
other ways.
2) Deallocation
free() expects a non-null pointer
delete and delete[] -check- the pointer for null before deallocating. There
is never a need to do:
if (foo)
delete foo;
This is equivalent to writing:
if (foo) {
if (foo) {
free(foo);
}
}
It's just silly.
Never, ever, ever mix malloc/free, new/delete, or new[]/delete[]. They are
all different and mixing them will just result in crashes. Make sure you
match them properly in all cases.
kst-2.0.3/devel-docs/general_1.x/codingstyle.txt 000644 001750 001750 00000011753 11544160206 022114 0 ustar 00synth synth 000000 000000 - indenting is emacs style 2 space, no tabs
- all files should have appropriate vim modelines at the end:
// vim: ts=2 sw=2 et
- bracing and structure style is as follows:
for (int x = 1; x < 10; ++x) {
val *= x;
}
if (x == y) {
z();
} else if (q < r) {
} else {
}
switch (expression) {
case 1:
foo();
break;
case 2:
default:
}
rettype Class::method(type var, type var, ...) {
type var;
type var2 = val, var3;
function();
etc
return var;
}
- class layout example:
class X : public Y, private Z {
Q_OBJECT
public:
X();
virtual ~X();
private:
public slots:
};
- all include files must be guarded:
#ifndef FILENAME_H
#define FILENAME_H
#endif
- avoid inline methods - it makes things difficult to modify later
- designer .ui.h files use designer default indenting format
- don't use superfluous semicolons. It causes compile problems with some
compilers.
- all .c, .cpp, .h files must have license and copyright headers
- all files must be licensed *GPL* unless it derives from non-GPL compatible
code, in which case you must contact the Kst developers and maintainers
before integrating it
- no C++ exceptions will be used
- the present hard requirements for compilation are KDE 3.3.0. No
new hard requirements may be added, though conditional compilation is fine.
- be very sensitive of performance (both startup time and runtime) of all Kst
components. profile often
- don't make constant unnecessary changes as part of other commits since it
destroys cvs annotations
- variables do not use "Hungarian notation" pchlzpstrMyVariable style of
naming. Qt/KDE style naming is preferred:
type myVariableName;
type _myMethodName;
- public variables should be avoided as much as possible as they eventually
will cause problems (circumvents locking). Naming can be myPublicName or
MyPublicName. Both are common in Kst. Perhaps this should be
standardized in the future.
- global variables must be namespaced in some way, and can use myGlobalName or
MyGlobalName naming styles as appropriate
- methods should use Qt-style myMethodName() naming style. functions should
use myFunctionName() or (less preferably) MyFunctionName()
- DCOP methods are public, and therefore must always be 100% clean. Do not
use short forms, be consistent in nomenclature, and follow the most
preferred and already-used capitalization schemes.
- Text literals must use i18n(). Be conscious of the fact that translators do
not know anything about Kst or perhaps about things like "PSD"s and "fit"s,
and that different languages have very different geometry, pluralization,
and word-order requirements. Consult KDE developer documentation for more
information.
- Kst is now nicely component-ized after much hard work. Let's keep it that
way. No huge monolithic/multipurpose classes. Use abstract interfaces and
concrete implementations, where applicable as KDE-style plugins.
- Discuss changes of design on the list first. Commit second. Sometimes a
concrete implementation as a branch or a patch set can be very convincing.
- Remember portability. Kst runs on many hardware and software platforms, is
compiled with various compilers, and is run in all kinds of strange
environments now. Just because it works on Linux or GCC doesn't mean it will
work anywhere else.
- Don't use char to store numbers, use int bitfields. Char is signed on some
platforms and unsigned on others, leading to all kinds of strange bugs.
- Make methods const where applicable to allow use of const objects and
pointers. Keep in mind if something may need to be non-const in the future
so that we don't break existing code.
- Don't use unnecessary const_cast - much effort was put into making the code
"const correct".
- Pass arguments and return values as const& where applicable for performance
reasons.
- Early returns to avoid huge nesting of blocks is -good-. It makes the code
easy to understand. Do it, and don't remove it. Use judgement to avoid
making soup.
- Have care to push class instantiations down as far as possible in scope.
Some are quite expensive to instantiate and there is no value in following
the old C-style declarations. Instantiating objects that aren't used just
slows down Kst.
- If you fix a bug for code that has substantial testing support in tests/, you
must add a testcase to avoid regressions in the future.
- Methods and functions that return their values through references are
-banned-. Do not add these as new code, and try to clean up old ones as you
go. If you must return multiple values individually, use a pointer. It's
too confusing to use references and leads to many hard-to-trace bugs. Ideally
use a single structure/class to encapsulate the data and return.
- Why do we do this? To make coding on Kst faster, easier, more consistent,
and more efficient.
kst-2.0.3/devel-docs/general_1.x/appdesign.txt 000644 001750 001750 00000002572 11544160206 021541 0 ustar 00synth synth 000000 000000
Kst is designed as a multi-layer application. The core is intended to be small
and well-focused on the core functionality. Additional features and
functionality are implemented as plugins, extensions, or datasource plugins.
libkst
------
This contains the bare minimum required by Kst extensions in order for them to
cleanly link and be sufficiently powerful to perform their tasks. It should
not contain any data or view object code at this time.
libkstmath
----------
All non-gui dependent math code and data objects (equations, PSDs, etc) go
here. This is not presently installed.
d2asc
-----
A command line utility to convert any kst supported data file into ascii.
kst
---
This is the core executable. It links to libkst, qt, KDE, and not much else.
kst proper contains only main.cpp. The rest is in libkstapp.
extensions
----------
Kst extensions allow developers to add functionality that may not be required
by all Kst users, or is more of a peripheral or optional component.
Extensions are loaded on demand of the user.
datasources
-----------
These are runtime loaded plugins which add support in Kst for loading files
of various formats.
plugins
-------
Plugins are Kst-independent loadable modules that implement new mathematical
algorithms for use inside Kst. These are often of limited or no value to most
users, so they should be implemented as plugins to avoid bloat.
kst-2.0.3/devel-docs/general_1.x/threading.txt 000644 001750 001750 00000006160 11544160206 021531 0 ustar 00synth synth 000000 000000
Notes on threading:
- you must lock and unlock global and shared objects to avoid races
- KstObject classes are also locks internally, so you can just ->readLock(),
->writeUnlock() etc on them directly.
- KstObjectList and Map classes have locks accessible with .lock()
- KstWriteLocker and KstReadLocker are useful to lock an object and ensure that
the object is unlocked when (and only when) the locker instance falls out of
scope. Only put these on the stack.
- KstShared objects must always be used by KstSharedPtr, NOT Foo*. If you
use Foo*, you will not get proper reference counting. In most cases a typedef
exists to make this easy.
- some Qt objects are shared:
- QMemarray
- QMap
- QString
- QValueList
- QValueVector
You need to make -deep- copies of these in particular when using
globals.
example:
KstDataObjectList mine = QDeepCopy(KST::dataObjectList);
This could crash if the dataObjectList is modified while mine is being
used. KST::dataObjectList is global and used from all threads in general. You
need to make a deep copy of the list.
- Use a write lock iff there is a possibility that you will modify the object.
- Don't make your locks too finegrained. If looping, either copy the data you
need in the loop temporarily, or lock around the outside of the loop instead
of constantly locking and unlocking inside the loop.
- Maximum recursion depth of read locks is 30. Maximum recursion of write
locks is 0. Locking for writing twice in the same thread is a guaranteed
deadlock.
- Locking is generally "explicit" in that if you are accessing object "x", you
must x->readLock(); /* read from x */ x->readUnlock(). x will not lock itself
when it needs to read members. The only implicit locking happens in a few
special cases, and in shared pointer reference counting (semaphore is used).
-------------------------------------------------------------------
08/10/06
How to fix our deadlock issues.
Recent changes to object complexity and performance of locking in Kst have
brought some old deadlock scenarios up in frequency and made Kst appear far
less stable. Past fixes for these deadlocks were apparently insufficient and
only fixes some cases. The most common scenario is this:
Thread 1 locks Object A
Object A starts to lock dependencies
Context switch
Thread 2 locks Object B
Object B starts to lock dependencies and eventually blocks on Object A
Context switch
Object A continues to lock dependencies and blocks on an object locked by B
-> deadlock
The general solution for this is to lock all objects in a consistent order,
such as pointer value of object or lock. We do this presently, but only at
each level, which is insufficient in complex object structures. One possible
solution is for KstDataObject to first obtain all pointers requiring locks,
recursively, and then sort and lock them iteratively. The problem is that in
order to obtain these pointers, we will need to have locks on the objects, thus
defeating the goal. It is proposed to split locking into shallow and deep
locking, allowing a shallow lock for tree reading, and a deep lock for more
complex operations.
kst-2.0.3/devel-docs/general_1.x/i18n.txt 000644 001750 001750 00000002130 11544160206 020334 0 ustar 00synth synth 000000 000000 Kst is now being actively translated by the KDE translation team. As such, we
should do our best to help them with their task. This means:
1) Make sure you i18n() or I18N_NOOP() your strings as appropriate.
2) Keep in mind that some languages are Right-To-Left. You cannot do things
like: QString foo = i18n("My first statement."); foo += i18n("\nmore text");
3) There are three variants of i18n() and I18N_NOOP(). We need to make heavy
use of the "comment" ones because the translators do not understand all of our
terminology:
i18n(const char *string);
i18n(const char *comment, const char *string);
i18n(const char *singular_form, const char *plural_form, unsigned long n);
The comment one looks like this: i18n("A curve that represents a \"best fit\" for another curve.", "Fit Curve");
4) Don't change i18n()s if you don't have to. It introduces "fuzzies" and
makes life difficult for translators.
5) Be aware of non-language issues for translation, such as dates (different
calendar systems), currencies, numerics, and units. KDE provides various
facilities to deal with some of these issues.
kst-2.0.3/devel-docs/doxygen/Doxyfile.doxy 000644 001750 001750 00000203676 11544160206 021100 0 ustar 00synth synth 000000 000000 # Doxyfile 1.6.3
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
#
# All text after a hash (#) is considered a comment and will be ignored
# The format is:
# TAG = value [value, ...]
# For lists items can also be appended using:
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (" ")
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
# iconv built into libc) for the transcoding. See
# http://www.gnu.org/software/libiconv for the list of possible encodings.
DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
PROJECT_NAME = kst
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
# if some version control system is used.
PROJECT_NUMBER = 2.0
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = .
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
# format and will distribute the generated files over these directories.
# Enabling this option can be useful when feeding doxygen a huge amount of
# source files, where putting all generated files in the same directory would
# otherwise cause performance problems for the file system.
CREATE_SUBDIRS = NO
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# The default language is English, other supported languages are:
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
OUTPUT_LANGUAGE = English
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
# include brief member descriptions after the members that are listed in
# the file and class documentation (similar to JavaDoc).
# Set to NO to disable this.
BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
# the brief description of a member or function before the detailed description.
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
REPEAT_BRIEF = YES
# This tag implements a quasi-intelligent brief description abbreviator
# that is used to form the text in various listings. Each string
# in this list, if found as the leading text of the brief description, will be
# stripped from the text and the result after processing the whole list, is
# used as the annotated text. Otherwise, the brief description is used as-is.
# If left blank, the following values are used ("$name" is automatically
# replaced with the name of the entity): "The $name class" "The $name widget"
# "The $name file" "is" "provides" "specifies" "contains"
# "represents" "a" "an" "the"
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# Doxygen will generate a detailed section even if there is only a brief
# description.
ALWAYS_DETAILED_SEC = NO
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
INLINE_INHERITED_MEMB = NO
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
# path before files name in the file list and in the header files. If set
# to NO the shortest path that makes the file name unique will be used.
FULL_PATH_NAMES = YES
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
# can be used to strip a user-defined part of the path. Stripping is
# only done if one of the specified strings matches the left-hand part of
# the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the
# path to strip.
STRIP_FROM_PATH = /Users/dimitri/doxygen/mail/1.5.7/doxywizard/
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
# the path mentioned in the documentation of a class, which tells
# the reader which header file to include in order to use a class.
# If left blank only the name of the header file containing the class
# definition is used. Otherwise one should specify the include paths that
# are normally passed to the compiler using the -I flag.
STRIP_FROM_INC_PATH =
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
# (but less readable) file names. This can be useful is your file systems
# doesn't support long names like on DOS, Mac, or CD-ROM.
SHORT_NAMES = NO
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
# will interpret the first line (until the first dot) of a JavaDoc-style
# comment as the brief description. If set to NO, the JavaDoc
# comments will behave just like regular Qt-style comments
# (thus requiring an explicit @brief command for a brief description.)
JAVADOC_AUTOBRIEF = NO
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
# interpret the first line (until the first dot) of a Qt-style
# comment as the brief description. If set to NO, the comments
# will behave just like regular Qt-style comments (thus requiring
# an explicit \brief command for a brief description.)
QT_AUTOBRIEF = NO
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
# comments) as a brief description. This used to be the default behaviour.
# The new default is to treat a multi-line C++ comment block as a detailed
# description. Set this tag to YES if you prefer the old behaviour instead.
MULTILINE_CPP_IS_BRIEF = NO
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
# re-implements.
INHERIT_DOCS = YES
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
# a new page for each member. If set to NO, the documentation of a member will
# be part of the file/class/namespace that contains it.
SEPARATE_MEMBER_PAGES = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
# Doxygen uses this value to replace tabs by spaces in code fragments.
TAB_SIZE = 8
# This tag can be used to specify a number of aliases that acts
# as commands in the documentation. An alias has the form "name=value".
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
# put the command \sideeffect (or @sideeffect) in the documentation, which
# will result in a user-defined paragraph with heading "Side Effects:".
# You can put \n's in the value part of an alias to insert newlines.
ALIASES =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.
# For instance, some of the names that are used will be different. The list
# of all members will be omitted, etc.
OPTIMIZE_OUTPUT_FOR_C = NO
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
# sources only. Doxygen will then generate output that is more tailored for
# Java. For instance, namespaces will be presented as packages, qualified
# scopes will look different, etc.
OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources only. Doxygen will then generate output that is more tailored for
# Fortran.
OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for
# VHDL.
OPTIMIZE_OUTPUT_VHDL = NO
# Doxygen selects the parser to use depending on the extension of the files it parses.
# With this tag you can assign which parser to use for a given extension.
# Doxygen has a built-in mapping, but you can override or extend it using this tag.
# The format is ext=language, where ext is a file extension, and language is one of
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
# use: inc=Fortran f=C. Note that for custom extensions you also need to set
# FILE_PATTERNS otherwise the files are not read by doxygen.
EXTENSION_MAPPING =
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should
# set this tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
# func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
BUILTIN_STL_SUPPORT = NO
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
# Doxygen will parse them like normal C++ but will assume all classes use public
# instead of private inheritance when no explicit protection keyword is present.
SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate getter
# and setter methods for a property. Setting this option to YES (the default)
# will make doxygen to replace the get and set methods by a property in the
# documentation. This will only work if the methods are indeed getting or
# setting a simple type. If this is not the case, or you want to show the
# methods anyway, you should set this option to NO.
IDL_PROPERTY_SUPPORT = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
DISTRIBUTE_GROUP_DOC = NO
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
# the same type (for instance a group of public functions) to be put as a
# subgroup of that type (e.g. under the Public Functions section). Set it to
# NO to prevent subgrouping. Alternatively, this can be done per class using
# the \nosubgrouping command.
SUBGROUPING = YES
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
# is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically
# be useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.
TYPEDEF_HIDES_STRUCT = NO
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
# determine which symbols to keep in memory and which to flush to disk.
# When the cache is full, less often used symbols will be written to disk.
# For small to medium size projects (<1000 input files) the default value is
# probably good enough. For larger projects a too small cache size can cause
# doxygen to be busy swapping symbols to and from disk most of the time
# causing a significant performance penality.
# If the system has enough physical memory increasing the cache will improve the
# performance by keeping more symbols in memory. Note that the value works on
# a logarithmic scale so increasing the size by one will rougly double the
# memory usage. The cache size is given by this formula:
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols
SYMBOL_CACHE_SIZE = 0
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
# documentation are documented, even if no documentation was available.
# Private class members and static file members will be hidden unless
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
EXTRACT_ALL = YES
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
EXTRACT_PRIVATE = YES
# If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation.
EXTRACT_STATIC = YES
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
# If set to NO only classes defined in header files are included.
EXTRACT_LOCAL_CLASSES = YES
# This flag is only useful for Objective-C code. When set to YES local
# methods, which are defined in the implementation section but not in
# the interface are included in the documentation.
# If set to NO (the default) only methods in the interface are included.
EXTRACT_LOCAL_METHODS = YES
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base
# name of the file that contains the anonymous namespace. By default
# anonymous namespace are hidden.
EXTRACT_ANON_NSPACES = YES
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# undocumented members of documented classes, files or namespaces.
# If set to NO (the default) these members will be included in the
# various overviews, but no documentation section is generated.
# This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_MEMBERS = NO
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
# If set to NO (the default) these classes will be included in the various
# overviews. This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_CLASSES = NO
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
# friend (class|struct|union) declarations.
# If set to NO (the default) these declarations will be included in the
# documentation.
HIDE_FRIEND_COMPOUNDS = NO
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
# documentation blocks found inside the body of a function.
# If set to NO (the default) these blocks will be appended to the
# function's detailed documentation block.
HIDE_IN_BODY_DOCS = NO
# The INTERNAL_DOCS tag determines if documentation
# that is typed after a \internal command is included. If the tag is set
# to NO (the default) then the documentation will be excluded.
# Set it to YES to include the internal documentation.
INTERNAL_DOCS = NO
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
# file names in lower-case letters. If set to YES upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# and Mac users are advised to set this option to NO.
CASE_SENSE_NAMES = NO
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
# will show members with their full class and namespace scopes in the
# documentation. If set to YES the scope will be hidden.
HIDE_SCOPE_NAMES = NO
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
# will put a list of the files that are included by a file in the documentation
# of that file.
SHOW_INCLUDE_FILES = YES
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
# will list include files with double quotes in the documentation
# rather than with sharp brackets.
FORCE_LOCAL_INCLUDES = NO
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
# is inserted in the documentation for inline members.
INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
# will sort the (detailed) documentation of file and class members
# alphabetically by member name. If set to NO the members will appear in
# declaration order.
SORT_MEMBER_DOCS = YES
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
# brief documentation of file, namespace and class members alphabetically
# by member name. If set to NO (the default) the members will appear in
# declaration order.
SORT_BRIEF_DOCS = NO
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
# will sort the (brief and detailed) documentation of class members so that
# constructors and destructors are listed first. If set to NO (the default)
# the constructors will appear in the respective orders defined by
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
SORT_MEMBERS_CTORS_1ST = NO
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
# hierarchy of group names into alphabetical order. If set to NO (the default)
# the group names will appear in their defined order.
SORT_GROUP_NAMES = NO
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
# sorted by fully-qualified names, including namespaces. If set to
# NO (the default), the class list will be sorted only by class name,
# not including the namespace part.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the
# alphabetical list.
SORT_BY_SCOPE_NAME = NO
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
# commands in the documentation.
GENERATE_TODOLIST = YES
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
# commands in the documentation.
GENERATE_TESTLIST = YES
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
# commands in the documentation.
GENERATE_BUGLIST = YES
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
# \deprecated commands in the documentation.
GENERATE_DEPRECATEDLIST= YES
# The ENABLED_SECTIONS tag can be used to enable conditional
# documentation sections, marked by \if sectionname ... \endif.
ENABLED_SECTIONS =
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
# the initial value of a variable or define consists of for it to appear in
# the documentation. If the initializer consists of more lines than specified
# here it will be hidden. Use a value of 0 to hide initializers completely.
# The appearance of the initializer of individual variables and defines in the
# documentation can be controlled using \showinitializer or \hideinitializer
# command in the documentation regardless of this setting.
MAX_INITIALIZER_LINES = 30
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
# at the bottom of the documentation of classes and structs. If set to YES the
# list will mention the files that were used to generate the documentation.
SHOW_USED_FILES = YES
# If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
# in the documentation. The default is NO.
SHOW_DIRECTORIES = NO
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the
# Folder Tree View (if specified). The default is YES.
SHOW_FILES = YES
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
# Namespaces page. This will remove the Namespaces entry from the Quick Index
# and from the Folder Tree View (if specified). The default is YES.
SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
# popen()) the command , where is the value of
# the FILE_VERSION_FILTER tag, and is the name of an input file
# provided by doxygen. Whatever the program writes to standard output
# is used as the file version. See the manual for examples.
FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
# doxygen. The layout file controls the global structure of the generated output files
# in an output format independent way. The create the layout file that represents
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
# file name after the option, if omitted DoxygenLayout.xml will be used as the name
# of the layout file.
LAYOUT_FILE =
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
# The QUIET tag can be used to turn on/off the messages that are generated
# by doxygen. Possible values are YES and NO. If left blank NO is used.
QUIET = NO
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
# NO is used.
WARNINGS = YES
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
# automatically be disabled.
WARN_IF_UNDOCUMENTED = YES
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some
# parameters in a documented function, or documenting parameters that
# don't exist or using markup commands wrongly.
WARN_IF_DOC_ERROR = YES
# This WARN_NO_PARAMDOC option can be abled to get warnings for
# functions that are documented, but have no documentation for their parameters
# or return value. If set to NO (the default) doxygen will only warn about
# wrong or incomplete parameter documentation, but not about the absence of
# documentation.
WARN_NO_PARAMDOC = NO
# The WARN_FORMAT tag determines the format of the warning messages that
# doxygen can produce. The string should contain the $file, $line, and $text
# tags, which will be replaced by the file and line number from which the
# warning originated and the warning text. Optionally the format may contain
# $version, which will be replaced by the version of the file (if it could
# be obtained via FILE_VERSION_FILTER)
WARN_FORMAT = "$file:$line: $text"
# The WARN_LOGFILE tag can be used to specify a file to which warning
# and error messages should be written. If left blank the output is written
# to stderr.
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
# The INPUT tag can be used to specify the files and/or directories that contain
# documented source files. You may enter file names like "myfile.cpp" or
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = ../../src
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
# also the default input encoding. Doxygen uses libiconv (or the iconv built
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
# the list of possible encodings.
INPUT_ENCODING = UTF-8
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank the following patterns are tested:
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
FILE_PATTERNS = *.c \
*.cc \
*.cxx \
*.cpp \
*.c++ \
*.d \
*.java \
*.ii \
*.ixx \
*.ipp \
*.i++ \
*.inl \
*.h \
*.hh \
*.hxx \
*.hpp \
*.h++ \
*.idl \
*.odl \
*.cs \
*.php \
*.php3 \
*.inc \
*.m \
*.mm \
*.dox \
*.py \
*.f90 \
*.f \
*.vhd \
*.vhdl
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
# If left blank NO is used.
RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
# from the input.
EXCLUDE_SYMLINKS = NO
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories. Note that the wildcards are matched
# against the file with absolute path, so to exclude all test directories
# for example use the pattern */test/*
EXCLUDE_PATTERNS = .svn
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
EXCLUDE_SYMBOLS =
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
# the \include command).
EXAMPLE_PATH =
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank all files are included.
EXAMPLE_PATTERNS = *
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude
# commands irrespective of the value of the RECURSIVE tag.
# Possible values are YES and NO. If left blank NO is used.
EXAMPLE_RECURSIVE = NO
# The IMAGE_PATH tag can be used to specify one or more files or
# directories that contain image that are included in the documentation (see
# the \image command).
IMAGE_PATH =
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command , where
# is the value of the INPUT_FILTER tag, and is the name of an
# input file. Doxygen will then use the output that the filter program writes
# to standard output. If FILTER_PATTERNS is specified, this tag will be
# ignored.
INPUT_FILTER =
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the
# filter if there is a match. The filters are a list of the form:
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
# is applied to all files.
FILTER_PATTERNS =
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will be used to filter the input files when producing source
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
# be generated. Documented entities will be cross-referenced with these sources.
# Note: To get rid of all source code in the generated output, make sure also
# VERBATIM_HEADERS is set to NO.
SOURCE_BROWSER = YES
# Setting the INLINE_SOURCES tag to YES will include the body
# of functions and classes directly in the documentation.
INLINE_SOURCES = YES
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
# fragments. Normal C and C++ comments will always remain visible.
STRIP_CODE_COMMENTS = NO
# If the REFERENCED_BY_RELATION tag is set to YES
# then for each documented function all documented
# functions referencing it will be listed.
REFERENCED_BY_RELATION = YES
# If the REFERENCES_RELATION tag is set to YES
# then for each documented function all documented entities
# called/used by that function will be listed.
REFERENCES_RELATION = YES
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
# link to the source code. Otherwise they will link to the documentation.
REFERENCES_LINK_SOURCE = YES
# If the USE_HTAGS tag is set to YES then the references to source code
# will point to the HTML generated by the htags(1) tool instead of doxygen
# built-in source browser. The htags tool is part of GNU's global source
# tagging system (see http://www.gnu.org/software/global/global.html). You
# will need version 4.8.6 or higher.
USE_HTAGS = NO
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
# will generate a verbatim copy of the header file for each class for
# which an include is specified. Set to NO to disable this.
VERBATIM_HEADERS = YES
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
# of all compounds will be generated. Enable this if the project
# contains a lot of classes, structs, unions or interfaces.
ALPHABETICAL_INDEX = NO
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
# in which this list will be split (can be a number in the range [1..20])
COLS_IN_ALPHA_INDEX = 5
# In case all classes in a project start with a common prefix, all
# classes will be put under the same header in the alphabetical index.
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
# should be ignored while generating the index headers.
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
# generate HTML output.
GENERATE_HTML = YES
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `html' will be used as the default path.
HTML_OUTPUT = html
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
# doxygen will generate files with .html extension.
HTML_FILE_EXTENSION = .html
# The HTML_HEADER tag can be used to specify a personal HTML header for
# each generated HTML page. If it is left blank doxygen will generate a
# standard header.
HTML_HEADER =
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
# standard footer.
HTML_FOOTER =
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to
# fine-tune the look of the HTML output. If the tag is left blank doxygen
# will generate a default style sheet. Note that doxygen will try to copy
# the style sheet file to the HTML output directory, so don't put your own
# stylesheet in the HTML output directory as well, or it will be erased!
HTML_STYLESHEET =
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting
# this to NO can help when comparing the output of multiple runs.
HTML_TIMESTAMP = YES
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
# NO a bullet list will be used.
HTML_ALIGN_MEMBERS = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded. For this to work a browser that supports
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
HTML_DYNAMIC_SECTIONS = NO
# If the GENERATE_DOCSET tag is set to YES, additional index files
# will be generated that can be used as input for Apple's Xcode 3
# integrated development environment, introduced with OSX 10.5 (Leopard).
# To create a documentation set, doxygen will generate a Makefile in the
# HTML output directory. Running make will produce the docset in that
# directory and running "make install" will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
# it at startup.
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
GENERATE_DOCSET = NO
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
# feed. A documentation feed provides an umbrella under which multiple
# documentation sets from a single provider (such as a company or product suite)
# can be grouped.
DOCSET_FEEDNAME = "Doxygen generated docs"
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
# should uniquely identify the documentation set bundle. This should be a
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
# will append .docset to the name.
DOCSET_BUNDLE_ID = org.doxygen.Project
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
# will be generated that can be used as input for tools like the
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
# of the generated HTML documentation.
GENERATE_HTMLHELP = NO
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
# be used to specify the file name of the resulting .chm file. You
# can add a path in front of the file if the result should not be
# written to the html output directory.
CHM_FILE =
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
# be used to specify the location (absolute path including file name) of
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
# the HTML help compiler on the generated index.hhp.
HHC_LOCATION =
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
# controls if a separate .chi index file is generated (YES) or that
# it should be included in the master .chm file (NO).
GENERATE_CHI = NO
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
# content.
CHM_INDEX_ENCODING =
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
# controls whether a binary table of contents is generated (YES) or a
# normal table of contents (NO) in the .chm file.
BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members
# to the contents of the HTML help documentation and to the tree view.
TOC_EXPAND = NO
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
# are set, an additional index file will be generated that can be used as input for
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
# HTML documentation.
GENERATE_QHP = NO
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
# be used to specify the file name of the resulting .qch file.
# The path specified is relative to the HTML output folder.
QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#namespace
QHP_NAMESPACE = org.doxygen.Project
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
QHP_VIRTUAL_FOLDER = doc
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
# For more information please see
# http://doc.trolltech.com/qthelpproject.html#custom-filters
QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
# Qt Help Project / Custom Filters.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
# filter section matches.
# Qt Help Project / Filter Attributes.
QHP_SECT_FILTER_ATTRS =
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
# be used to specify the location of Qt's qhelpgenerator.
# If non-empty doxygen will try to run qhelpgenerator on the generated
# .qhp file.
QHG_LOCATION =
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
# will be generated, which together with the HTML files, form an Eclipse help
# plugin. To install this plugin and make it available under the help contents
# menu in Eclipse, the contents of the directory containing the HTML and XML
# files needs to be copied into the plugins directory of eclipse. The name of
# the directory within the plugins directory should be the same as
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
# the help appears.
GENERATE_ECLIPSEHELP = NO
# A unique identifier for the eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have
# this name.
ECLIPSE_DOC_ID = org.doxygen.Project
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
# top of each HTML page. The value NO (the default) enables the index and
# the value YES disables it.
DISABLE_INDEX = NO
# This tag can be used to set the number of enum values (range [1..20])
# that doxygen will group on one line in the generated HTML documentation.
ENUM_VALUES_PER_LINE = 4
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information.
# If the tag value is set to YES, a side panel will be generated
# containing a tree-like index structure (just like the one that
# is generated for HTML Help). For this to work a browser that supports
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
# Windows users are probably better off using the HTML help feature.
GENERATE_TREEVIEW = NO
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
# and Class Hierarchy pages using a tree view instead of an ordered list.
USE_INLINE_TREES = NO
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree
# is shown.
TREEVIEW_WIDTH = 250
# Use this tag to change the font size of Latex formulas included
# as images in the HTML documentation. The default is 10. Note that
# when you change the font size after a successful doxygen run you need
# to manually remove any form_*.png images from the HTML output directory
# to force them to be regenerated.
FORMULA_FONTSIZE = 10
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
# for the HTML output. The underlying search engine uses javascript
# and DHTML and should work on any modern browser. Note that when using
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
# (GENERATE_DOCSET) there is already a search function so this one should
# typically be disabled. For large projects the javascript based search engine
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
SEARCHENGINE = YES
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a PHP enabled web server instead of at the web client
# using Javascript. Doxygen will generate the search PHP script and index
# file to put on the web server. The advantage of the server
# based approach is that it scales better to large projects and allows
# full text search. The disadvances is that it is more difficult to setup
# and does not have live searching capabilities.
SERVER_BASED_SEARCH = NO
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `latex' will be used as the default path.
LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked. If left blank `latex' will be used as the default command name.
# Note that when enabling USE_PDFLATEX this option is only used for
# generating bitmaps for formulas in the HTML output, but not in the
# Makefile that is written to the output directory.
LATEX_CMD_NAME = latex
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
# generate index for LaTeX. If left blank `makeindex' will be used as the
# default command name.
MAKEINDEX_CMD_NAME = makeindex
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
# LaTeX documents. This may be useful for small projects and may help to
# save some trees in general.
COMPACT_LATEX = NO
# The PAPER_TYPE tag can be used to set the paper type that is used
# by the printer. Possible values are: a4, a4wide, letter, legal and
# executive. If left blank a4wide will be used.
PAPER_TYPE = a4wide
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
# packages that should be included in the LaTeX output.
EXTRA_PACKAGES =
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
# the generated latex document. The header should contain everything until
# the first chapter. If it is left blank doxygen will generate a
# standard header. Notice: only use this tag if you know what you are doing!
LATEX_HEADER =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
# contain links (just like the HTML output) instead of page references
# This makes the output suitable for online browsing using a pdf viewer.
PDF_HYPERLINKS = YES
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
# plain latex in the generated Makefile. Set this option to YES to get a
# higher quality PDF documentation.
USE_PDFLATEX = YES
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
# command to the generated LaTeX files. This will instruct LaTeX to keep
# running if errors occur, instead of asking the user for help.
# This option is also used when generating formulas in HTML.
LATEX_BATCHMODE = NO
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
# include the index chapters (such as File Index, Compound Index, etc.)
# in the output.
LATEX_HIDE_INDICES = NO
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
# source code with syntax highlighting in the LaTeX output.
# Note that which sources are shown also depends on other settings
# such as SOURCE_BROWSER.
LATEX_SOURCE_CODE = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
# The RTF output is optimized for Word 97 and may not look very pretty with
# other RTF readers or editors.
GENERATE_RTF = NO
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `rtf' will be used as the default path.
RTF_OUTPUT = rtf
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
# RTF documents. This may be useful for small projects and may help to
# save some trees in general.
COMPACT_RTF = NO
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
# will contain hyperlink fields. The RTF file will
# contain links (just like the HTML output) instead of page references.
# This makes the output suitable for online browsing using WORD or other
# programs which support those fields.
# Note: wordpad (write) and others do not support links.
RTF_HYPERLINKS = NO
# Load stylesheet definitions from file. Syntax is similar to doxygen's
# config file, i.e. a series of assignments. You only have to provide
# replacements, missing definitions are set to their default value.
RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an rtf document.
# Syntax is similar to doxygen's config file.
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
# generate man pages
GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `man' will be used as the default path.
MAN_OUTPUT = man
# The MAN_EXTENSION tag determines the extension that is added to
# the generated man pages (default is the subroutine's section .3)
MAN_EXTENSION = .3
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
# then it will generate one additional man file for each entity
# documented in the real man page(s). These additional files
# only source the real man page, but without them the man command
# would be unable to find the correct page. The default is NO.
MAN_LINKS = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
# If the GENERATE_XML tag is set to YES Doxygen will
# generate an XML file that captures the structure of
# the code including all documentation.
GENERATE_XML = NO
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `xml' will be used as the default path.
XML_OUTPUT = xml
# The XML_SCHEMA tag can be used to specify an XML schema,
# which can be used by a validating XML parser to check the
# syntax of the XML files.
XML_SCHEMA =
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
# syntax of the XML files.
XML_DTD =
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
# dump the program listings (including syntax highlighting
# and cross-referencing information) to the XML output. Note that
# enabling this will significantly increase the size of the XML output.
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
# generate an AutoGen Definitions (see autogen.sf.net) file
# that captures the structure of the code including all
# documentation. Note that this feature is still experimental
# and incomplete at the moment.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
# generate a Perl module file that captures the structure of
# the code including all documentation. Note that this
# feature is still experimental and incomplete at the
# moment.
GENERATE_PERLMOD = NO
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
# to generate PDF and DVI output from the Perl module output.
PERLMOD_LATEX = NO
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
# nicely formatted so it can be parsed by a human reader. This is useful
# if you want to understand what is going on. On the other hand, if this
# tag is set to NO the size of the Perl module output will be much smaller
# and Perl will parse it just the same.
PERLMOD_PRETTY = YES
# The names of the make variables in the generated doxyrules.make file
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
# This is useful so different doxyrules.make files included by the same
# Makefile don't overwrite each other's variables.
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
# evaluate all C-preprocessor directives found in the sources and include
# files.
ENABLE_PREPROCESSING = YES
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
# names in the source code. If set to NO (the default) only conditional
# compilation will be performed. Macro expansion can be done in a controlled
# way by setting EXPAND_ONLY_PREDEF to YES.
MACRO_EXPANSION = NO
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
# then the macro expansion is limited to the macros specified with the
# PREDEFINED and EXPAND_AS_DEFINED tags.
EXPAND_ONLY_PREDEF = NO
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
# in the INCLUDE_PATH (see below) will be search if a #include is found.
SEARCH_INCLUDES = YES
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by
# the preprocessor.
INCLUDE_PATH =
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will
# be used.
INCLUDE_FILE_PATTERNS =
# The PREDEFINED tag can be used to specify one or more macro names that
# are defined before the preprocessor is started (similar to the -D option of
# gcc). The argument of the tag is a list of macros of the form: name
# or name=definition (no spaces). If the definition and the = are
# omitted =1 is assumed. To prevent a macro definition from being
# undefined via #undef or recursively expanded use the := operator
# instead of the = operator.
PREDEFINED =
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.
# The macro definition that is found in the sources will be used.
# Use the PREDEFINED tag if you want to use a different macro definition.
EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
# doxygen's preprocessor will remove all function-like macros that are alone
# on a line, have an all uppercase name, and do not end with a semicolon. Such
# function macros are typically used for boiler-plate code, and will confuse
# the parser if not removed.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------
# The TAGFILES option can be used to specify one or more tagfiles.
# Optionally an initial location of the external documentation
# can be added for each tagfile. The format of a tag file without
# this location is as follows:
# TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
# TAGFILES = file1=loc1 "file2 = loc2" ...
# where "loc1" and "loc2" can be relative or absolute paths or
# URLs. If a location is present for each tag, the installdox tool
# does not have to be run to correct the links.
# Note that each tag file must have a unique name
# (where the name does NOT include the path)
# If a tag file is not located in the directory in which doxygen
# is run, you must also specify the path to the tagfile here.
TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads.
GENERATE_TAGFILE =
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes
# will be listed.
ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
# in the modules index. If set to NO, only the current project's groups will
# be listed.
EXTERNAL_GROUPS = YES
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of `which perl').
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
# or super classes. Setting the tag to NO turns the diagrams off. Note that
# this option is superseded by the HAVE_DOT option below. This is only a
# fallback. It is recommended to install and use dot, since it yields more
# powerful graphs.
CLASS_DIAGRAMS = YES
# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.
MSCGEN_PATH =
# If set to YES, the inheritance and collaboration graphs will hide
# inheritance and usage relations if the target is undocumented
# or is not a class.
HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz, a graph visualization
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
# have no effect if this option is set to NO (the default)
HAVE_DOT = YES
# By default doxygen will write a font called FreeSans.ttf to the output
# directory and reference it in all dot files that doxygen generates. This
# font does not include all possible unicode characters however, so when you need
# these (or just want a differently looking font) you can specify the font name
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
# which can be done by putting it in a standard location or by setting the
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
# containing the font.
DOT_FONTNAME = FreeSans
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
# The default size is 10pt.
DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the output directory to look for the
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
# different font using DOT_FONTNAME you can set the path where dot
# can find it using this tag.
DOT_FONTPATH =
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect inheritance relations. Setting this tag to YES will force the
# the CLASS_DIAGRAMS tag to NO.
CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect implementation dependencies (inheritance, containment, and
# class references variables) of the class with other documented classes.
COLLABORATION_GRAPH = YES
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for groups, showing the direct groups dependencies
GROUP_GRAPHS = YES
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language.
UML_LOOK = NO
# If set to YES, the inheritance and collaboration graphs will show the
# relations between templates and their instances.
TEMPLATE_RELATIONS = NO
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
# tags are set to YES then doxygen will generate a graph for each documented
# file showing the direct and indirect include dependencies of the file with
# other documented files.
INCLUDE_GRAPH = NO
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
# documented header file showing the documented files that directly or
# indirectly include this file.
INCLUDED_BY_GRAPH = NO
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
# doxygen will generate a call dependency graph for every global function
# or class method. Note that enabling this option will significantly increase
# the time of a run. So in most cases it will be better to enable call graphs
# for selected functions only using the \callgraph command.
CALL_GRAPH = YES
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
# doxygen will generate a caller dependency graph for every global function
# or class method. Note that enabling this option will significantly increase
# the time of a run. So in most cases it will be better to enable caller
# graphs for selected functions only using the \callergraph command.
CALLER_GRAPH = YES
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
# will graphical hierarchy of all classes instead of a textual one.
GRAPHICAL_HIERARCHY = YES
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
# then doxygen will show the dependencies a directory has on other directories
# in a graphical way. The dependency relations are determined by the #include
# relations between the files in the directories.
DIRECTORY_GRAPH = NO
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. Possible values are png, jpg, or gif
# If left blank png will be used.
DOT_IMAGE_FORMAT = png
# The tag DOT_PATH can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the
# \dotfile command).
DOTFILE_DIRS =
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
# nodes that will be shown in the graph. If the number of nodes in a graph
# becomes larger than this value, doxygen will truncate the graph, which is
# visualized by representing a node as a red box. Note that doxygen if the
# number of direct children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
DOT_GRAPH_MAX_NODES = 50
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
# graphs generated by dot. A depth value of 3 means that only nodes reachable
# from the root by following a path via at most 3 edges will be shown. Nodes
# that lay further from the root node will be omitted. Note that setting this
# option to 1 or 2 may greatly reduce the computation time needed for large
# code bases. Also note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not
# seem to support this out of the box. Warning: Depending on the platform used,
# enabling this option may lead to badly anti-aliased labels on the edges of
# a graph (i.e. they become hard to read).
DOT_TRANSPARENT = NO
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10)
# support this, this feature is disabled by default.
DOT_MULTI_TARGETS = NO
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
# generate a legend page explaining the meaning of the various boxes and
# arrows in the dot generated graphs.
GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
# remove the intermediate dot files that are used to generate
# the various graphs.
DOT_CLEANUP = YES
kst-2.0.3/devel-docs/krazy2.out 000644 001750 001750 00000116225 11544160206 016677 0 ustar 00synth synth 000000 000000
krazy2 Analysis
Checkers Run = 45
Files Processed = 752
Total Issues = 717 ...as of October 04 2010 10:07:12 EDT
==>For File Type c++<==
1. Check for TRUE and FALSE macros [captruefalse]... Ok!
2. Check for methods that return 'const' refs in public classes [constref]... Ok!
3. Check for an acceptable copyright [copyright]... 5 issues found
./plugins/dataobject/genericfilter/filter.h: missing tags: email address(line 7) (1)
./plugins/dataobject/genericfilter/polynom.h: missing tags: email address(line 7) (1)
./libkst/sysinfo.c: missing tags: email address(line 2) (1)
./libkstapp/gridlayouthelper.h: missing tags: email address(line 25) (1)
./libkstapp/gridlayouthelper.cpp: missing tags: email address(line 25) (1)
All source files must contain a copyright header which identifies
the copyright holder(s) together with a e-mail address that can be
used to reach the copyright holder. One copyright holder per line,
with real email addresses please. For details regarding KDE's
licensing policy please visit
. A typical
copyright looks like: "Copyright 2002,2005-2006 Joe Hacker
"
4. Check for cpp macros and usage [cpp]... 32 issues found
./widgets/curveappearance.cpp: O/S or Compiler specific macro line#377[Q_WS_WIN32] (1)
./libkstmath/basicplugin.cpp: O/S or Compiler specific macro line#17[Q_WS_WIN32] (1)
./libkstmath/labelparser.h: O/S or Compiler specific macro line#67[Q_WS_WIN32] (1)
./libkstmath/curve.cpp: O/S or Compiler specific macro line#43[__GNUC__],555[Q_WS_WIN32] (2)
./libkstmath/enodes.cpp: O/S or Compiler specific macro line#23[Q_WS_WIN32],389[Q_WS_WIN32] (2)
./libkstmath/escan.cpp: O/S or Compiler specific macro line#511[Q_WS_WIN32],1498[Q_WS_WIN32],1526[Q_WS_WIN32] (3)
./libkstmath/eventmonitorentry.cpp: O/S or Compiler specific macro line#34[Q_WS_WIN32] (1)
./libkst/kst_inf.h: O/S or Compiler specific macro line#21[__sun] (1)
./libkst/psversion.h: O/S or Compiler specific macro line#2[__linux__] (1)
./libkst/procps.h: O/S or Compiler specific macro line#58[__GNUC__,__GNUC_MINOR__],66[__GNUC__,__GNUC_MINOR__],83[__GNUC__,__GNUC_MINOR__] (3)
./libkst/procps.h: Guard #warning with '#ifdef __GNUC__' line#61 (1)
./libkst/datacollection.cpp: O/S or Compiler specific macro line#33[__linux__],47[__linux__] (2)
./libkst/sysinfo.h: O/S or Compiler specific macro line#12[__linux__] (1)
./libkst/ksttimers.h: Unknown HAVE_FOO macro line#18[HAVE_KST_USE_TIMERS] (1)
./libkst/datasourcepluginmanager.cpp: O/S or Compiler specific macro line#247[Q_WS_WIN32],282[Q_WS_WIN32] (2)
./libkst/math_kst.h: O/S or Compiler specific macro line#23[__sun],63[__APPLE__],82[__SVR4,__sun],86[Q_WS_WIN32] (4)
./libkstapp/memorywidget.cpp: O/S or Compiler specific macro line#34[__linux__] (1)
./libkstapp/bugreportwizard.cpp: O/S or Compiler specific macro line#35[Q_WS_WIN32],37[Q_WS_WIN64] (2)
./libkstapp/viewitemdialog.cpp: O/S or Compiler specific macro line#297[Q_WS_WIN32] (1)
./libkstapp/datawizard.cpp: O/S or Compiler specific macro line#718[__linux__] (1)
C++ source files and non-installed headers should NOT use cpp
conditionals that check for a certain O/S or compiler; instead use
CMake HAVE_foo macros. We want to check for features discovered
during CMake time rather than for a specific O/S.
5. Check for code that should be considered crashy. [crashy]... Ok!
6. Check single-char QString operations for efficiency [doublequote_chars]... 8 issues found
./plugins/dataobject/effectivebandwidth/effectivebandwidth.cpp: line#24 (1)
./plugins/dataobject/syncbin/syncbin.cpp: line#36 (1)
./plugins/dataobject/linefit/linefit.cpp: line#27,28 (2)
./libkstmath/equation.cpp: line#48,50 (2)
./libkstmath/eventmonitorentry.cpp: line#60,61 (2)
Adding single characters to a QString is faster if the characters
are QChars and not QStrings. For example: QString path = oldpath +
"/" + base is better written as QString path = oldpath + '/' +
base. Same holds for arguments to QString::startsWith(),
QString::endsWith(), QString::remove(), QString::section(), and
QString::split(). Use QString::remove() instead of
QString::replace(foo,"")
7. Check for unwanted doxygen tags in major versions [doxytags]... Ok!
8. Check public classes with private members or d-pointer issues [dpointer]... Ok!
9. Check for QString compares to "" [emptystrcompare]... Ok!
10. Check that file ends with a newline [endswithnewline]... Ok!
11. Check for C++ ctors that should be declared 'explicit' [explicit]... Ok!
12. Check for foreach loop issues [foreach]... 62 issues found
X ./widgets/gradienteditor.cpp: non-const ref iterator line#76,146,199,211 (4)
X ./widgets/stringselector.cpp: non-const ref iterator line#131 (1)
X ./widgets/vectorselector.cpp: non-const ref iterator line#194 (1)
X ./widgets/curveselector.cpp: non-const ref iterator line#122 (1)
X ./widgets/matrixselector.cpp: non-const ref iterator line#132 (1)
./widgets/scalarselector.cpp: non-const ref iterator line#215 (1)
./libkstmath/objectfactory.cpp: non-const ref iterator line#49 (1)
./libkstmath/relationfactory.cpp: non-const ref iterator line#49 (1)
./libkstmath/dataobject.cpp: non-const ref iterator line#102,104 (2)
./datasources/qimagesource/qimagesource.cpp: non-const ref iterator line#538 (1)
./libkst/datasourcefactory.cpp: non-const ref iterator line#49 (1)
./libkst/datasourcepluginmanager.cpp: non-const ref iterator line#136,138 (2)
./libkst/primitivefactory.cpp: non-const ref iterator line#49 (1)
./libkstapp/powerspectrumdialog.cpp: non-const ref iterator line#286 (1)
./libkstapp/legenditem.cpp: non-const ref iterator line#143,251 (2)
./libkstapp/matrixdialog.cpp: non-const ref iterator line#808,869 (2)
./libkstapp/exportgraphicsdialog.cpp: non-const ref iterator line#37 (1)
./libkstapp/viewgridlayout.cpp: non-const ref iterator line#151,318,415,519,548,601,641,657,686 (9)
./libkstapp/imagedialog.cpp: non-const ref iterator line#501 (1)
./libkstapp/plotitemdialog.cpp: non-const ref iterator line#462 (1)
./libkstapp/vectordialog.cpp: non-const ref iterator line#471,524 (2)
./libkstapp/histogramdialog.cpp: non-const ref iterator line#428 (1)
./libkstapp/csddialog.cpp: non-const ref iterator line#278 (1)
./libkstapp/labelrenderer.cpp: non-const ref iterator line#232 (1)
./libkstapp/applicationsettings.cpp: non-const ref iterator line#278 (1)
./libkstapp/graphicsfactory.cpp: non-const ref iterator line#49 (1)
./libkstapp/curvedialog.cpp: non-const ref iterator line#453 (1)
./libkstapp/mainwindow.cpp: non-const ref iterator line#1065,1070,1075 (3)
./libkstapp/plotitem.cpp: non-const ref iterator line#1358,1388,1415,3344,3759,3769 (6)
./libkstapp/changefiledialog.cpp: values or keys iteration line#423,452 (2)
./libkstapp/logwidget.cpp: non-const ref iterator line#115 (1)
./libkstapp/equationdialog.cpp: non-const ref iterator line#363 (1)
./libkstapp/viewitem.cpp: non-const ref iterator line#192 (1)
./libkstapp/viewitemdialog.cpp: non-const ref iterator line#147 (1)
./libkstapp/eventmonitordialog.cpp: non-const ref iterator line#341 (1)
./libkstapp/scalarmodel.cpp: non-const ref iterator line#198 (1)
./libkstapp/legenditemdialog.cpp: non-const ref iterator line#158 (1)
./libkstapp/debugdialog.cpp: non-const ref iterator line#85 (1)
When not using POD types (int, double, pointer, ...) you should use
const & for your foreach variables. There are two reasons for this:
1) Prevents you from the mistake of writing foreach loops that
modify the list, that is 'foreach(Foo f, list) f.a = f.b = f.c =
0;' compiles but does not modify the contents of list 2) Saves a
copy constructor call for each of the list elements
13. Check validity of i18n calls [i18ncheckarg]... 103 issues found
./plugins/filters/differentiation/differentiation.cpp: wrong argument count, have 0 need 2 line#137
./plugins/filters/differentiation/differentiation.cpp: wrong argument count, have 0 need 1 line#139
./plugins/filters/despike/filterdespike.cpp: wrong argument count, have 0 need 1 line#155
./plugins/filters/despike/filterdespike.cpp: wrong argument count, have 0 need 3 line#153
./plugins/filters/cumulativesum/cumulativesum.cpp: wrong argument count, have 0 need 2 line#137
./plugins/filters/cumulativesum/cumulativesum.cpp: wrong argument count, have 0 need 1 line#139
./widgets/labelbuilder.cpp: malformed markup (unmatched tags, etc.) line#24
./libkstmath/basicplugin.cpp: wrong argument count, have 0 need 1 line#231,402
./libkstmath/curve.cpp: wrong argument count, have 0 need 2 line#381,1540,1565
./libkstmath/curve.cpp: wrong argument count, have 0 need 1 line#1549,1553,1557,1561,1569
./libkstmath/curve.cpp: wrong argument count, have 0 need 3 line#1546
./libkstmath/enodes.cpp: wrong argument count, have 0 need 1 line#752
./libkstmath/equation.cpp: wrong argument count, have 0 need 3 line#614
./libkstmath/equation.cpp: wrong argument count, have 0 need 1 line#155,179,228,235,237
./libkstmath/histogram.cpp: wrong argument count, have 0 need 3 line#426
./libkstmath/histogram.cpp: wrong argument count, have 0 need 1 line#316,422,428
./libkstmath/psd.cpp: wrong argument count, have 0 need 2 line#452
./libkstmath/psd.cpp: wrong argument count, have 0 need 1 line#460
./libkstmath/psd.cpp: single adjective as message, probably ambiguous; use context call to explain what it refers to line#456
./libkstmath/plotdefines.h: malformed markup (unmatched tags, etc.) line#63,64
./libkstmath/csd.cpp: wrong argument count, have 0 need 2 line#90,357,360,381
./libkstmath/csd.cpp: wrong argument count, have 0 need 1 line#92,198,363,366,389
./libkstmath/csd.cpp: single adjective as message, probably ambiguous; use context call to explain what it refers to line#385
./libkstmath/eventmonitorentry.cpp: wrong argument count, have 0 need 1 line#518
./libkstmath/eventmonitorentry.cpp: reported ambiguous message by translators; use context call to explain what it refers to line#514,518
./libkstmath/image.cpp: wrong argument count, have 0 need 1 line#142,799
./libkstmath/dataobject.cpp: wrong argument count, have 0 need 3 line#424
./datasources/ascii/asciisource.cpp: wrong argument count, have 0 need 1 line#610
./libkst/datastring.cpp: wrong argument count, have 0 need 2 line#151
./libkst/datastring.cpp: wrong argument count, have 0 need 4 line#142
./libkst/debug.cpp: wrong argument count, have 0 need 1 line#137
./libkst/string_kst.cpp: wrong argument count, have 0 need 1 line#101
./libkst/datavector.cpp: wrong argument count, have 0 need 2 line#735
./libkst/datavector.cpp: wrong argument count, have 0 need 1 line#731,733,739,741
./libkst/datavector.cpp: wrong argument count, have 0 need 3 line#725
./libkst/datavector.cpp: wrong argument count, have 0 need 4 line#748
./libkst/datamatrix.cpp: wrong argument count, have 0 need 5 line#632
./libkst/datamatrix.cpp: wrong argument count, have 0 need 2 line#640
./libkst/datamatrix.cpp: wrong argument count, have 0 need 1 line#174
./libkst/datascalar.cpp: wrong argument count, have 0 need 3 line#151
./libkst/datascalar.cpp: wrong argument count, have 0 need 4 line#142
./libkst/generatedvector.cpp: wrong argument count, have 0 need 3 line#92
./libkst/generatedvector.cpp: wrong argument count, have 0 need 4 line#87
./libkst/vscalar.cpp: wrong argument count, have 0 need 5 line#172
./libkst/vscalar.cpp: wrong argument count, have 0 need 4 line#193
./libkst/vector.cpp: wrong argument count, have 0 need 3 line#617
./libkst/matrix.cpp: wrong argument count, have 0 need 3 line#625
./libkst/scalar.cpp: wrong argument count, have 0 need 2 line#139
./libkst/scalar.cpp: wrong argument count, have 0 need 1 line#156
./libkst/scalar.cpp: wrong argument count, have 0 need 3 line#137
./libkst/editablevector.cpp: wrong argument count, have 0 need 2 line#82
./libkst/datasource.cpp: single adjective as message, probably ambiguous; use context call to explain what it refers to line#77
./libkstapp/legenditem.cpp: wrong argument count, have 0 need 2 line#423
./libkstapp/plotaxis.cpp: reported ambiguous message by translators; use context call to explain what it refers to line#785
./libkstapp/labelpropertiestab.cpp: malformed markup (unmatched tags, etc.) line#30
./libkstapp/plotitem.cpp: wrong argument count, have 0 need 2 line#3264
./libkstapp/logwidget.cpp: wrong argument count, have 0 need 3 line#57
./libkstapp/debugdialog.cpp: wrong argument count, have 0 need 2 line#41
./libkstapp/debugdialog.cpp: wrong argument count, have 0 need 1 line#43
./libkstapp/datawizard.cpp: wrong argument count, have 0 need 2 line#772
./libkstapp/commandlineparser.cpp: wrong argument count, have 0 need 1 line#420,463,504,544
./libkstapp/commandlineparser.cpp: malformed markup (unmatched tags, etc.) line#371,373,375,380,402,404,406,409,456,497,538,565,567
Make the translators' job easier and detect problems in the usage
of the i18n() calls. When the fix is not clear, check the Techbase
article at
for more information.
14. Check for invalid icon names [iconnames]... Ok!
15. Check for proper include directives [includes]... 71 issues found
./plugins/dataobject/interpolations/interpolations.h: missing or improper include guard in header
./plugins/fits/non_linear.h: missing or improper include guard in header
./plugins/fits/non_linear_weighted.h: missing or improper include guard in header
./plugins/fits/linear_weighted.h: missing or improper include guard in header
./plugins/fits/common.h: missing or improper include guard in header
./plugins/fits/linear.h: missing or improper include guard in header
./plugins/fits/kneefrequency/fitkneefrequency.h: missing or improper include guard in header
./plugins/filters/filters.h: missing or improper include guard in header
./libkstmath/basicplugin.cpp: include own header first line#24
./libkstmath/curve.cpp: include own header first line#32
./libkstmath/enodes.cpp: include own header first line#34
./libkstmath/equation.cpp: include own header first line#34
./libkstmath/histogram.cpp: include own header first line#28
./libkstmath/psd.cpp: include own header first line#33
./libkstmath/psdcalculator.cpp: include own header first line#26
./libkstmath/colorsequence.h: using leading or trailing underscores on include guard in header
./libkstmath/EosA.h: missing or improper include guard in header
./libkstmath/EosB.h: missing or improper include guard in header
./libkstmath/Spectrum.h: missing or improper include guard in header
./libkstmath/palette.h: using leading or trailing underscores on include guard in header
./libkstmath/emailthread.cpp: include own header first line#22
./libkstmath/settings.cpp: include own header first line#21
./libkstmath/doublecompare.h: missing or improper include guard in header
./libkstmath/escan.cpp: duplicate includes line#24,490(stdio.h);25,491(string.h);27,489(stdlib.h)
./libkstmath/RED-Temperature.h: missing or improper include guard in header
./libkstmath/csd.cpp: include own header first line#27
./libkstmath/eventmonitorentry.cpp: include own header first line#27
./libkstmath/image.cpp: include own header first line#18
./datasources/netcdf/kstnetcdf.cpp: include own header first line#23
./libkst/datastring.cpp: include own header first line#22
./libkst/primitive.cpp: include own header first line#25
./libkst/psversion.h: put config.h in angle brackets line#1
./libkst/debug.cpp: include own header first line#14
./libkst/stdinsource.h: missing or improper include guard in header
./libkst/datacollection.cpp: include own header first line#23
./libkst/string_kst.cpp: include own header first line#22
./libkst/datavector.cpp: include own header first line#30
./libkst/datamatrix.cpp: include own header first line#26
./libkst/datascalar.cpp: include own header first line#22
./libkst/object.cpp: include own header first line#20
./libkst/generatedvector.cpp: include own header first line#22
./libkst/timezones.h: using leading or trailing underscores on include guard in header
./libkst/objectstore.cpp: include own header first line#23
./libkst/generatedmatrix.cpp: include own header first line#20
./libkst/vscalar.cpp: include own header first line#22
./libkst/vector.cpp: include own header first line#30
./libkst/datasourcepluginmanager.cpp: duplicate includes line#13,42(datasourcepluginmanager.h)
./libkst/matrix.cpp: include own header first line#24
./libkst/scalar.cpp: include own header first line#24
./libkst/editablevector.cpp: include own header first line#19
./libkst/stdinsource.cpp: include own header first line#20
./libkst/stdinsource.cpp: put config.h in angle brackets line#19
./libkstapp/plotitem.h: duplicate includes line#19,27(namedobject.h)
./libkstapp/memorywidget.cpp: put config.h in angle brackets line#13
./libkstapp/stringdialog.cpp: include own header first line#14
./libkstapp/dialog.cpp: include own header first line#13
./libkstapp/generaltab.cpp: include own header first line#14
./libkstapp/rangetab.cpp: include own header first line#18
./libkstapp/datadialog.cpp: include own header first line#21
./libkstapp/overridelabeltab.h: missing or improper include guard in header
./libkstapp/vectordialog.cpp: include own header first line#13
./libkstapp/scalardialog.cpp: include own header first line#15
./libkstapp/defaultlabelpropertiestab.cpp: include own header first line#13
./libkstapp/plotmarkers.h: using leading or trailing underscores on include guard in header
./libkstapp/mainwindow.cpp: do not include QtModules line#59(QtGui)
./libkstapp/bugreportwizard.cpp: put config.h in angle brackets line#14
./libkstapp/aboutdialog.cpp: put config.h in angle brackets line#13
./libkstapp/plotrenderitem.cpp: duplicate includes line#16,20(application.h)
./libkstapp/dimensionstab.cpp: include own header first line#13
Use <..> to include installed headers; to include
Qt headers from installed headers; cpp file should include their
own headers first (but below config.h); other rules apply, see
. Use include guards in headers with appropriatedly
encoded macro names.
16. Check for inline methods in public classes [inline]... Ok!
17. Check for an acceptable license [license]... 10 issues found
./plugins/dataobject/crossspectrum/fftsg_h.c: missing license
./plugins/dataobject/genericfilter/filter.h: missing license
./plugins/dataobject/genericfilter/polynom.h: missing license
./libkstmath/fftsg_h.c: missing license
./datasources/ascii/kst_atof.cpp: missing license
./datasources/ascii/kst_atof.h: missing license
./kst/main-vld.cpp: missing license
./libkst/sharedptr.h: LGPL (v2) (wrong address)
./libkstapp/gridlayouthelper.h: GPL v3+ or v2-only is not compatible with Qt or KDE licensing
./libkstapp/gridlayouthelper.cpp: GPL v3+ or v2-only is not compatible with Qt or KDE licensing
Each source file must contain a license or a reference to a license
which states under which terms the software may be used, modified
and redistributed. For details regarding KDE's licensing policy
please visit .
18. Check for assignments to QString::null [nullstrassign]... 13 issues found
./libkstmath/emailthread.h: line#33,34 (2)
./datasources/lfiio/lfiio.cpp: line#32 (1)
./datasources/lfiio/lfiio.h: line#40 (1)
./datasources/planckIDEF/planckIDEF.h: line#54 (1)
./datasources/planckIDEF/planckIDEF.cpp: line#35 (1)
./datasources/healpix/healpix.h: line#44 (1)
./datasources/healpix/healpix.cpp: line#50 (1)
./libkst/dataprimitive.cpp: line#62 (1)
./libkst/stdinsource.h: line#48 (1)
./libkst/dataplugin.h: line#36 (1)
./libkst/stdinsource.cpp: line#159 (1)
./libkstapp/debugdialog.cpp: line#93 (1)
Do not assign QString::null or QString() to a QString. Instead use
the .clear() method. For example, "str = QString::null" becomes
"str.clear()". When returning an empty string from a method use
"return QString()" When passing an empty string use "QString()".
19. Check for compares to QString::null or QString() [nullstrcompare]... Ok!
20. Check for C++ operators that should be 'const' [operators]... Ok!
21. Check for inappropriate pass-by-value function args [passbyvalue]... Ok!
22. Check for postfix usage of ++ and -- [postfixop]... 142 issues found
./plugins/dataobject/crossspectrum/crossspectrum.cpp: line#218,232,240,256,273,283 (6)
./plugins/dataobject/periodogram/periodogram.cpp: line#378,382,490,535,541,602,611,619,737,749,756,761,774 (13)
./plugins/dataobject/linefit/linefit.cpp: line#187,201,217 (3)
./plugins/fits/gradient_weighted/fitgradient_weighted.cpp: line#205 (1)
./plugins/fits/kneefrequency/fitkneefrequency.cpp: line#277,292,315,320,325 (5)
./plugins/fits/linear_weighted/fitlinear_weighted.cpp: line#208 (1)
./plugins/fits/linear_unweighted/fitlinear_unweighted.cpp: line#191 (1)
./plugins/fits/gradient_unweighted/fitgradient_unweighted.cpp: line#188 (1)
./plugins/filters/despike/filterdespike.cpp: line#193,205,228,252 (4)
./widgets/stringselector.cpp: line#74 (1)
./widgets/vectorselector.cpp: line#89 (1)
./widgets/curveselector.cpp: line#62 (1)
./widgets/scalarselector.cpp: line#146 (1)
./d2asc/d2asc.cpp: line#61,65,103,116,125,126 (6)
./libkstmath/curve.cpp: line#518,1094,1106,1209,1299 (5)
./libkstmath/histogram.cpp: line#142,156,202 (3)
./libkstmath/psdcalculator.cpp: line#193,213,222,226,230,234,238,242,246,250,261,286,293,299,305 (15)
./datasources/fitsimage/fitsimage.cpp: line#274,275,281,282,288,289,295,296 (8)
./datasources/lfiio/lfiio.cpp: line#169,253,258,311,550 (5)
./datasources/ascii/asciisource.cpp: line#422 (1)
./datasources/planckIDEF/planckIDEF.cpp: line#315,375,528,623,746,814,1320 (7)
./datasources/healpix/healpix_tools_pix.cpp: line#83,87,765,771,776,782 (6)
./datasources/healpix/healpix_tools_fits.cpp: line#55,64,92,101 (4)
./datasources/qimagesource/qimagesource.cpp: line#121,127,133,139 (4)
./libkst/datavector.cpp: line#454,508,569 (3)
./libkst/vector.cpp: line#398,436,475 (3)
./libkst/matrix.cpp: line#216,225,228,236,245,253 (6)
./libkst/timezones.cpp: line#746,750,755,761,786,791,796 (7)
./libkstapp/gridlayouthelper.cpp: line#351,359,372,383,390,403,415,421,434,445,451,464,484,490,491,504,508,513,518,523 (20)
You should use ++ and -- as prefix whenever possible as these are
more efficient than postfix operators. Prefix increments first and
then uses the variable, postfix uses the actual; the variable is
incremented as well. Because of this, the prefix operators are
inherently more efficient. *WARNING* Make sure that you don't
introduce off-by-one errors when changing i++ to ++i.
23. Check for dangerous or inefficient QByteArray usage [qbytearray]... Ok!
24. Check for Qt classes that should not be used [qclasses]... 52 issues found
./widgets/filerequester.cpp: QLineEdit[KLineEdit],QFileDialog[KFileDialog],QFileDialog[KFileDialog] (3)
./widgets/gradienteditor.cpp: QColorDialog[KColorDialog] (1)
./widgets/labellineedit.cpp: QLineEdit[KLineEdit] (1)
./widgets/datasourceselector.cpp: QLineEdit[KLineEdit] (1)
./widgets/combobox.h: QComboBox[KComboBox] (1)
./widgets/datasourceselectordialog.h: QFileDialog[KFileDialog] (1)
./widgets/colorbutton.cpp: QColorDialog[KColorDialog] (1)
./widgets/combobox.cpp: QLineEdit[KLineEdit] (1)
./widgets/datasourceselectordialog.cpp: QMessageBox[KMessageBox],QFileDialog[KFileDialog] (2)
./widgets/labellineedit.h: QLineEdit[KLineEdit] (1)
./libkst/datasourcepluginmanager.cpp: QUrl[KUrl] (1)
./libkstapp/pictureitem.cpp: QFileDialog[KFileDialog] (1)
./libkstapp/dialog.cpp: QDialog[KDialog] (1)
./libkstapp/filterfitdialog.cpp: QMessageBox[KMessageBox] (1)
./libkstapp/svgitem.cpp: QFileDialog[KFileDialog] (1)
./libkstapp/datadialog.cpp: QLineEdit[KLineEdit] (1)
./libkstapp/logwidget.h: QTextBrowser[KTextBrowser] (1)
./libkstapp/choosecolordialog.cpp: QDialog[KDialog],QLineEdit[KLineEdit],QLineEdit[KLineEdit] (3)
./libkstapp/mainwindow.cpp: QMessageBox[KMessageBox],QFileDialog[KFileDialog],QMessageBox[KMessageBox],QFileDialog[KFileDialog],QMessageBox[KMessageBox] (5)
./libkstapp/changefiledialog.cpp: QDialog[KDialog],QMessageBox[KMessageBox],QMessageBox[KMessageBox],QMessageBox[KMessageBox] (4)
./libkstapp/differentiatecurvesdialog.cpp: QDialog[KDialog] (1)
./libkstapp/dialogpage.cpp: QTabWidget[KTabWidget] (1)
./libkstapp/basicplugindialog.cpp: QMessageBox[KMessageBox] (1)
./libkstapp/viewitem.cpp: QInputDialog[KInputDialog] (1)
./libkstapp/datamanager.cpp: QDialog[KDialog] (1)
./libkstapp/viewvectordialog.cpp: QDialog[KDialog] (1)
./libkstapp/viewmatrixdialog.cpp: QDialog[KDialog] (1)
./libkstapp/markerstab.cpp: QMessageBox[KMessageBox],QMessageBox[KMessageBox] (2)
./libkstapp/viewitemdialog.cpp: QLineEdit[KLineEdit] (1)
./libkstapp/changedatasampledialog.cpp: QDialog[KDialog] (1)
./libkstapp/view.cpp: QInputDialog[KInputDialog] (1)
./libkstapp/tabwidget.cpp: QTabBar[KTabBar],QTabBar[KTabBar],QInputDialog[KInputDialog],QTabBar[KTabBar] (4)
./libkstapp/debugdialog.cpp: QDialog[KDialog],QDialog[KDialog] (2)
./libkstapp/tabwidget.h: QTabWidget[KTabWidget] (1)
./libkstapp/datawizard.cpp: QMessageBox[KMessageBox] (1)
Don't use Qt 4 classes that are deprecated. Additionally make sure
to use the KDE version of some Qt GUI elements to provide a
consistent look and feel for the KDE desktop. The KDE classes are
not just adding functionalities to the Qt base class and are mostly
not even based on the Qt class.
*Please* *refer*
*to* *the* *API* *documentation* *for* *details* *before* *porting*
*to* *the* *K* *classes*.
25. Check for Qt methods that should be avoided [qmethods]... Ok!
26. Check for QMIN and QMAX macros [qminmax]... Ok!
27. Check for classes that should use the 'Q_OBJECT' macro [qobject]... Ok!
28. Check for signals: and slots: [sigsandslots]... Ok!
29. Check for spelling errors [spelling]... 24 issues found
./plugins/dataobject/genericfilter/polynom.h: line#20[acces],60[acces] (2)
./plugins/sampleplugin/sampleplugin.cpp: line#93[everytime],104[everytime],145[occured] (3)
./widgets/dialogdefaults.h: line#41[retreived] (1)
./libkstmath/equation.cpp: line#493[occurences],543[occurences],546[occurences],571[occurences] (4)
./libkstmath/histogram.cpp: line#148[boundry],149[boundry] (2)
./libkstmath/eventmonitorentry.cpp: line#418[occurences],460[occurences],463[occurences],480[occurences] (4)
./libkst/datavector.cpp: line#366[devided] (1)
./libkst/timezones.h: line#206[customised] (1)
./libkst/objectstore.cpp: line#59[existant],65[existant] (2)
./libkst/timezones.cpp: line#777[abbrevations] (1)
./libkst/updatemanager.cpp: line#81[progess] (1)
./libkstapp/labelitem.cpp: line#78[noticable] (1)
./libkstapp/viewitem.h: line#522[aquired] (1)
Spelling errors in comments and strings should be fixed as they may
show up later in API documentation, handbooks, etc. Misspelled
strings make the translator's job harder. Please use US English.
30. Check for strings used improperly or should be i18n. [strings]... 35 issues found
./libkstmath/labelparser.cpp: QLatin1String issues line#210,214,225,229,239,243,247,257,261,275,279,283,293,297,337,349,353,357,371,375,379,383,397,414,426,438,442,460,464,468,478,490 (32)
./libkst/datasourcepluginmanager.cpp: QLatin1String issues line#140 (1)
./libkst/timezones.cpp: QLatin1String issues line#594 (1)
./libkstapp/document.cpp: QLatin1String issues line#63 (1)
Some QString methods (like startsWith() and endsWith()) are more
efficient if they are passed a QLatin1String, avoiding an implicit
conversion from const char *.
31. Check for system calls to replace by KDE or Qt equivalents [syscalls]... 5 issues found
./libkst/timezones.cpp: line#276 getenv[qgetenv],325 getenv[qgetenv],422 getenv[qgetenv],518 getenv[qgetenv] (4)
./libkstapp/document.cpp: line#148 open[KDE_open] (1)
Some system calls are not portable, please use the suggested
portable wrapper instead. See kde_file.h
32. Check for typedefs that should be replaced by Qt typedefs [typedefs]... 3 issues found
./libkstmath/escan.cpp: line#48 int8_t[qint8],#50 int16_t[qint16],#52 int32_t[qint32] (3)
Please use Qt typedefs (like qint32 and qreal) as defined in
QGlobals. These typedefs are guaranteed to have the size in bits
that the name states on all platforms.
==>For File Type designer<==
1. Check that file ends with a newline [endswithnewline]... Ok!
2. Check for files that need to be fixed by 'fixuifiles' [fixuifiles]... 14 issues found
./libkstapp/overridelabeltab.ui: fixuifiles needs to be run on this file
./libkstapp/datawizardpagevectors.ui: fixuifiles needs to be run on this file
./libkstapp/contenttab.ui: fixuifiles needs to be run on this file
./libkstapp/labelcreator.ui: fixuifiles needs to be run on this file
./libkstapp/labelpropertiestab.ui: fixuifiles needs to be run on this file
./libkstapp/legendtab.ui: fixuifiles needs to be run on this file
./libkstapp/labeltab.ui: fixuifiles needs to be run on this file
Please run the trunk/kdesdk/fixuifiles on all your .ui files as
there are some artifacts created by Qt designer that are
undesireable for KDE.
3. Check validity of i18n calls [i18ncheckarg]... 55 issues found
./plugins/fits/gradient_weighted/fitgradient_weightedconfig.ui: reported ambiguous message by translators; use context call to explain what it refers to line#29
./plugins/fits/polynomial_unweighted/fitpolynomial_unweightedconfig.ui: reported ambiguous message by translators; use context call to explain what it refers to line#31
./plugins/fits/linear_unweighted/fitlinear_unweightedconfig.ui: reported ambiguous message by translators; use context call to explain what it refers to line#31
./plugins/fits/exponential_weighted/fitexponential_weightedconfig.ui: reported ambiguous message by translators; use context call to explain what it refers to line#23
./plugins/fits/exponential_unweighted/fitexponential_unweightedconfig.ui: reported ambiguous message by translators; use context call to explain what it refers to line#31
./plugins/fits/gaussian_unweighted/fitgaussian_unweightedconfig.ui: reported ambiguous message by translators; use context call to explain what it refers to line#31
./plugins/fits/gradient_unweighted/fitgradient_unweightedconfig.ui: reported ambiguous message by translators; use context call to explain what it refers to line#31
./plugins/fits/sinusoid_unweighted/fitsinusoid_unweightedconfig.ui: reported ambiguous message by translators; use context call to explain what it refers to line#29
./plugins/fits/gaussian_weighted/fitgaussian_weightedconfig.ui: reported ambiguous message by translators; use context call to explain what it refers to line#29
./plugins/fits/lorentzian_unweighted/fitlorentzian_unweightedconfig.ui: reported ambiguous message by translators; use context call to explain what it refers to line#31
./widgets/curveappearance.ui: reported ambiguous message by translators; use context call to explain what it refers to line#187
./widgets/curveappearance.ui: single adjective as message, probably ambiguous; use context call to explain what it refers to line#192,197,202,361
./widgets/fftoptions.ui: reported ambiguous message by translators; use context call to explain what it refers to line#44
./widgets/scalarlistselector.ui: reported ambiguous message by translators; use context call to explain what it refers to line#41
./widgets/vectorselector.ui: reported ambiguous message by translators; use context call to explain what it refers to line#33
./widgets/matrixselector.ui: reported ambiguous message by translators; use context call to explain what it refers to line#27
./datasources/healpix/healpixconfig.ui: reported ambiguous message by translators; use context call to explain what it refers to line#34
./libkstapp/editmultiplewidget.ui: single adjective as message, probably ambiguous; use context call to explain what it refers to line#65
./libkstapp/differentiatecurvesdialog.ui: reported ambiguous message by translators; use context call to explain what it refers to line#245
./libkstapp/differentiatecurvesdialog.ui: single adjective as message, probably ambiguous; use context call to explain what it refers to line#110,130,250,255,260
./libkstapp/matrixtab.ui: single adjective as message, probably ambiguous; use context call to explain what it refers to line#669
./libkstapp/overridelabeltab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#20
./libkstapp/stroketab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#14
./libkstapp/gridtab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#14
./libkstapp/eventmonitortab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#169
./libkstapp/eventmonitortab.ui: single adjective as message, probably ambiguous; use context call to explain what it refers to line#199
./libkstapp/labelcreator.ui: reported ambiguous message by translators; use context call to explain what it refers to line#80
./libkstapp/labelcreator.ui: single adjective as message, probably ambiguous; use context call to explain what it refers to line#87,103
./libkstapp/dimensionstab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#14
./libkstapp/imagetab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#14
./libkstapp/layouttab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#14
./libkstapp/filltab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#20
./libkstapp/axistab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#14
./libkstapp/labelpropertiestab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#17
./libkstapp/labelpropertiestab.ui: single adjective as message, probably ambiguous; use context call to explain what it refers to line#70,89
./libkstapp/generaltab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#14
./libkstapp/legendtab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#19
./libkstapp/dialogpage.ui: reported ambiguous message by translators; use context call to explain what it refers to line#13
./libkstapp/defaultlabelpropertiestab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#14,164
./libkstapp/arrowpropertiestab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#16
./libkstapp/labeltab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#14
./libkstapp/rangetab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#14
./libkstapp/childviewoptionstab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#13
./libkstapp/histogramtab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#110
./libkstapp/markerstab.ui: reported ambiguous message by translators; use context call to explain what it refers to line#14
Make the translators' job easier and detect problems in the usage
of the i18n() calls. When the fix is not clear, check the Techbase
article at
for more information.
4. Check for Qt classes that should not be used [qclasses]... 82 issues found
./widgets/colorpalette.ui: QComboBox[KComboBox] (1)
./widgets/curveappearance.ui: QComboBox[KComboBox],QComboBox[KComboBox],QComboBox[KComboBox],QComboBox[KComboBox] (4)
./widgets/fftoptions.ui: QComboBox[KComboBox],QLineEdit[KLineEdit],QLineEdit[KLineEdit],QLineEdit[KLineEdit],QComboBox[KComboBox] (5)
./widgets/scalarlistselector.ui: QLineEdit[KLineEdit] (1)
./widgets/curveplacement.ui: QComboBox[KComboBox] (1)
./widgets/datarange.ui: QLineEdit[KLineEdit],QLineEdit[KLineEdit],QComboBox[KComboBox],QComboBox[KComboBox] (4)
./datasources/ascii/asciiconfig.ui: QLineEdit[KLineEdit],QLineEdit[KLineEdit],QComboBox[KComboBox],QComboBox[KComboBox],QLineEdit[KLineEdit] (5)
./datasources/healpix/healpixconfig.ui: QComboBox[KComboBox],QLineEdit[KLineEdit],QLineEdit[KLineEdit],QComboBox[KComboBox],QLineEdit[KLineEdit],QLineEdit[KLineEdit],QComboBox[KComboBox],QComboBox[KComboBox],QLineEdit[KLineEdit] (9)
./libkstapp/stringtab.ui: QLineEdit[KLineEdit] (1)
./libkstapp/editmultiplewidget.ui: QLineEdit[KLineEdit] (1)
./libkstapp/differentiatecurvesdialog.ui: QComboBox[KComboBox] (1)
./libkstapp/exportgraphicsdialog.ui: QComboBox[KComboBox] (1)
./libkstapp/matrixtab.ui: QLineEdit[KLineEdit],QLineEdit[KLineEdit],QLineEdit[KLineEdit],QLineEdit[KLineEdit],QLineEdit[KLineEdit],QLineEdit[KLineEdit] (6)
./libkstapp/datawizardpagevectors.ui: QLineEdit[KLineEdit] (1)
./libkstapp/equationtab.ui: QComboBox[KComboBox],QLineEdit[KLineEdit] (2)
./libkstapp/stroketab.ui: QComboBox[KComboBox],QComboBox[KComboBox],QComboBox[KComboBox],QComboBox[KComboBox] (4)
./libkstapp/eventmonitortab.ui: QLineEdit[KLineEdit],QComboBox[KComboBox],QLineEdit[KLineEdit],QLineEdit[KLineEdit],QTextEdit[KTextEdit] (5)
./libkstapp/debugdialog.ui: QTabWidget[KTabWidget] (1)
./libkstapp/imagetab.ui: QLineEdit[KLineEdit],QLineEdit[KLineEdit] (2)
./libkstapp/filltab.ui: QComboBox[KComboBox] (1)
./libkstapp/axistab.ui: QComboBox[KComboBox],QComboBox[KComboBox],QComboBox[KComboBox],QComboBox[KComboBox],QComboBox[KComboBox] (5)
./libkstapp/vectortab.ui: QLineEdit[KLineEdit],QLineEdit[KLineEdit],QComboBox[KComboBox] (3)
./libkstapp/legendtab.ui: QLineEdit[KLineEdit] (1)
./libkstapp/dialogpage.ui: QTabWidget[KTabWidget] (1)
./libkstapp/defaultlabelpropertiestab.ui: QComboBox[KComboBox] (1)
./libkstapp/datawizardpagedatasource.ui: QComboBox[KComboBox] (1)
./libkstapp/rangetab.ui: QLineEdit[KLineEdit],QLineEdit[KLineEdit],QLineEdit[KLineEdit],QLineEdit[KLineEdit],QLineEdit[KLineEdit],QLineEdit[KLineEdit] (6)
./libkstapp/histogramtab.ui: QLineEdit[KLineEdit],QLineEdit[KLineEdit] (2)
./libkstapp/markerstab.ui: QLineEdit[KLineEdit],QComboBox[KComboBox] (2)
./libkstapp/filterfittab.ui: QComboBox[KComboBox] (1)
./libkstapp/aboutdialog.ui: QTextBrowser[KTextBrowser] (1)
./libkstapp/scalartab.ui: QLineEdit[KLineEdit],QLineEdit[KLineEdit] (2)
Don't use Qt 4 classes that are deprecated. Additionally make sure
to use the KDE version of some Qt GUI elements to provide a
consistent look and feel for the KDE desktop. The KDE classes are
not just adding functionalities to the Qt base class and are mostly
not even based on the Qt class.
*Please* *refer*
*to* *the* *API* *documentation* *for* *details* *before* *porting*
*to* *the* *K* *classes*.
5. Check for spelling errors [spelling]... Ok!
==>For File Type desktop<==
1. Check that file ends with a newline [endswithnewline]... Ok!
2. Check for invalid icon names [iconnames]... Ok!
3. Check for spelling errors [spelling]... Ok!
4. Validates desktop files using 'desktop-file-validate' [validate]... Ok!
==>For File Type kpartgui<==
1. Check that file ends with a newline [endswithnewline]... Ok!
2. Check validity of i18n calls [i18ncheckarg]... Ok!
3. Check for spelling errors [spelling]... Ok!
4. Validates kpartgui files using 'xmllint' [validate]... 1 issue found
./kst/kst_icon.rc: 1: parser error : Start tag expected, '<' not found
Please make sure your .rc files conform to the XSD schema found in
kdelibs/kdeui/xmlgui/kxmlgui.xsd
kst-2.0.3/devel-docs/plugins/StartHere 000644 001750 001750 00000004412 11544160206 020223 0 ustar 00synth synth 000000 000000 How To Make Kst Plugins
-----------------------
KstPlugins are modules that can be loaded into Kst to provide additional
functionality.
KstPlugins are presently implemented as:
- KstDataSource plugins
+ These provide the ability to read in different file formats or data
"sources".
- KstDataObject plugins
+ These are advanced data plugins that provide their own configuration dialog.
- KstBasicPlugin plugins
+ These are basic data plugins that inherit KstDataObject plugins, but
are provided with a default configuration dialog.
- KstCPlugin plugins
+ These are deprecated data plugins replaced by KstBasicPlugins.
- Kst Extensions
+ These allow entire subsystems to be added to Kst without touching
the Kst core.
All KstPlugins except KstCPlugins are KDE style plugins and therefore require
a .desktop file and must be installed in the KDE standard plugins directories.
They derive from the base servicetype "Kst/Plugin". This base type includes
two kst specific properties:
X-Kst-Plugin-Author: A string containing the name of the author.
X-Kst-Plugin-Version: A string containing the version of the plugin.
,desktop files also have additional properties. Here are the required ones:
Name: A string containing the name of the plugin. For instance, "My Plugin".
ServiceTypes: For KstDataSource this is "Kst Data Source" and for KstDataObjects this is "Kst Data Object" etc, etc...
X-KDE-ModuleType: This should be set to "Plugin".
X-KDE-Library: The library name. This is not the filename, but a name
that is used to construct it. For instance, it could
be "kstobject_myplugin" where the library might be named
"kstobject_myplugin.so". This must also be a legal C
variable name as it is used to construct the function
names inside the library. Note: for KstDataSource plugins the
name here is shortened even further: the actual library name is
kstdata_myplugin.so, but you should put "myplugin" as the value
for this property.
Some other .desktop properties are also common to all plugins:
Comment: The description of the plugin.
To find out more about creating these plugins look in the respective file for
the type of plugin you are interested in creating.
kst-2.0.3/devel-docs/plugins/KstBasicPlugins 000644 001750 001750 00000007246 11544160206 021377 0 ustar 00synth synth 000000 000000 KstBasicPlugin Plugins
----------------------
The purpose of a KstBasicPlugin plugin is to provide an implementation of the
virtual class "KstDataObject" via the abstract class "KstBasicPlugin." Plugin
writers need to provide a class that inherits "KstBasicPlugin" and a .desktop
file.
Here is an example of the .desktop file named 'kstobject_myplugin.desktop':
[Desktop Entry]
Encoding=UTF-8
Type=Service
ServiceTypes=Kst Data Object
X-KDE-ModuleType=Plugin
X-KDE-Library=kstobject_fooplugin
X-Kst-Plugin-Author=Your Name
X-Kst-Plugin-Version=0.1
Name=Foo
Comment=A plugin that provides Foo algorithm.
Your C++ class should inherit KstBasicPlugin and provide implementations of the
pure virtual methods found in KstBasicPlugin:
//The implementation of the algorithm the plugin provides.
//Operates on the inputVectors, inputScalars, and inputStrings
//to produce the outputVectors, outputScalars, and outputStrings.
virtual bool algorithm() = 0;
//String lists of the names of the expected inputs.
virtual QStringList inputVectorList() const = 0;
virtual QStringList inputScalarList() const = 0;
virtual QStringList inputStringList() const = 0;
//String lists of the names of the expected outputs.
virtual QStringList outputVectorList() const = 0;
virtual QStringList outputScalarList() const = 0;
virtual QStringList outputStringList() const = 0;
Here is an example of a plugins header file:
#ifndef FOOPLUGIN_H
#define FOOPLUGIN_H
#include
class FooPlugin : public KstBasicPlugin {
Q_OBJECT
public:
FooPlugin(QObject *parent, const char *name, const QStringList &args);
virtual ~FooPlugin();
virtual bool algorithm();
virtual QStringList inputVectorList() const;
virtual QStringList inputScalarList() const;
virtual QStringList inputStringList() const;
virtual QStringList outputVectorList() const;
virtual QStringList outputScalarList() const;
virtual QStringList outputStringList() const;
};
And here is an example of a plugins cpp file:
#include "fooplugin.h"
#include
static const QString& VECTOR_IN = KGlobal::staticQString("Vector In");
static const QString& SCALAR_IN = KGlobal::staticQString("Scalar In");
static const QString& STRING_IN = KGlobal::staticQString("String In");
static const QString& VECTOR_OUT = KGlobal::staticQString("Vector Out");
static const QString& SCALAR_OUT = KGlobal::staticQString("Scalar Out");
static const QString& STRING_OUT = KGlobal::staticQString("String Out");
K_EXPORT_COMPONENT_FACTORY( kstobject_fooplugin,
KGenericFactory( "kstobject_fooplugin" ) )
FooPlugin::FooPlugin( QObject */*parent*/, const char */*name*/, const QStringList &/*args*/ )
: KstBasicPlugin() {
}
FooPlugin::~FooPlugin() {
}
bool FooPlugin::algorithm() {
//Do something...
return true;
}
QStringList FooPlugin::inputVectorList() const {
return QStringList( VECTOR_IN );
}
QStringList FooPlugin::inputScalarList() const {
return QStringList( SCALAR_IN );
}
QStringList FooPlugin::inputStringList() const {
return QStringList( STRING_IN );
}
QStringList FooPlugin::outputVectorList() const {
return QStringList( VECTOR_OUT );
}
QStringList FooPlugin::outputScalarList() const {
return QStringList( SCALAR_OUT );
}
QStringList FooPlugin::outputStringList() const {
return QStringList( STRING_OUT );
}
#include "fooplugin.moc"
The KstBasicPlugin takes care of providing almost everything, including the
configuration widget for your plugin. The one thing it doesn't do is provide
the actual algorithm or the names of the inputs/outputs.
See the Line Fit plugin for an example implementation.
kst-2.0.3/devel-docs/plugins/KstCPlugins 000644 001750 001750 00000014404 11544160206 020532 0 ustar 00synth synth 000000 000000 *****************************************************************************
WARNING!!! These plugins are now deprecated. Plugin writers
should instead consider writing such plugins by inheriting either
KstDataObject or KstBasicPlugin. See the KstPlugin file for more info.
*****************************************************************************
KstCPlugin Plugins
------------
Kst C plugins consist of two files, an XML file and a shared object. The XML
file describes the contents of the shared object file. The shared object file
contains the actual plugin code, and must export a C-style function.
XML FILE
--------
See linefit/linefit.xml for an example of an XML file.
Each XML file contains an node with the following information:
All but are required.
The module also contains an node which describes the interface to
the plugin. This node has children of type and