Code Monkey home page Code Monkey logo

kylinpluginframework's Introduction

KylinPluginFramework

Build Status Build Status Coverage Status Codacy Badge 996.icu LICENSE LICENSE

KPF(Kylin Plugin Framework) is a light weight plugin framework for Qt, free to cooperate with 3rd-party library without any code injection.

Features

  • Light weight: Only a single dll file.
  • Dynamic load: Load any QObject class to build your program architecture by configuration file, just like building LEGO!
  • No injection: Any QObject classes could be supported with a single line of declaration like Q_DECL_METATYPE, you can write it anywhere before loading the object. So you could configure any QObject classes from 3-rd party library without any code injection.
  • EventBus: Publish/Subscribe mechanism supported to decouple sender and receiver:
    • Better performance than signals&slots.
    • Easier to write than signals&slots.
    • Both synchronized and asynchronized events are supported, just like Qt::DirectConnection and Qt::QueuedConnection.
  • Better signal&slots:
    • Connect signals and slots by configuration file is also supported, just like eventbus.
    • Published event could connect to signals/slots, signals could connect to subscribed event too.
  • Configure everything:
    • QObject's every property could be configured
    • QObject's object-tree-hierarchy is also supported.
    • Object can be initialized in sub-thread by configuration, you needn't write any code about it.
  • Component: Separated configuration files are supported -- a component file is used to describe a subset of the configuration, and it behaves like a single concrete object, to be configured in other components or main configuration file.
  • Powerful log system: KPF use log4qt(Not which one migrated from log4j) to record logs.
  • Plentiful APIs: Advanced user can control every behaviors described above.

Docs

Only coments at present, sorry for this.

Examples

There's a simply example in test folder, which shows the features with configuration file and several classes.

Roadmap

  1. Submit code before 2019.7.7
  2. Finish documentation with Doxygen(See Another repository for example).
  3. Migrate configuration file format from json to xml.
  4. Migrate log system to log4qt(The existing logging system in KPF is prototype of my log4qt repo).
  5. Unit tests and CI support for travis, appveyor and coveralls.
  6. Other further maintenance:
    1. Operational monitoring;
    2. Hotswap support.
    3. ...

kylinpluginframework's People

Contributors

codacy-badger avatar zgblkylin avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.