• Introduction
• Quick overview
  • cpp hello world
  • lua hello world
  • powerful dynamic register
  • powerful abstract IO
• Getting started
• Detailed
  • Requirement
  • Main features
  • License

Introduction

welcome to ZFFramework, a cross-platform and powerful application framework in C++

everything here starts with "ZF", which stands for "Zero Framework"

• it's not a traditional framework, can be loaded like a dynamic library, plug and play
• designed to be able to run at any platform that supplies C++03 compatible implementation

Homepage:

• Online docs: http://ZFFramework.com

• Github repo: https://github.com/ZFFramework/ZFFramework

  

• history version: ZFFrameworkDist

Quick overview

cpp hello world

this piece of code shows how to show a hello world on UI and log output

#include "ZFUIWidget.h" // for common UI module
ZFMAIN_ENTRY() { // app starts from here
    // show a hello world to log output
    zfLog() << "hello wolrd";

    // show a window (full screen by default)
    zfobj<ZFUIWindow> window;
    window->windowShow();

    // show a hello world as a text view
    zfobj<ZFUITextView> textView;
    window->childAdd(textView)->c_alignTop()->c_margin(40);
    textView->text("hello world");

    // button and click (as observer)
    zfobj<ZFUIButtonBasic> button;
    window->childAdd(button)->c_alignBottom()->c_margin(40);
    button->label()->text("click me");
    button->onClick([](const ZFArgs &zfargs) {
        ZFUIButtonBasic *button = zfargs.sender();
        zfLogTrim() << "button clicked: " << button;
    });
}

lua hello world

this piece of code shows equivalent lua code to use ZFFramework, all the lua bindings are automatically done by reflection!

zfLog('hello world')

local window = ZFUIWindow()
window:windowShow()

local textView = zfAlloc('ZFUITextView')
window:childAdd(textView):alignTop():margin(40)
textView:text('hello wolrd')

local button = ZFUIButtonBasic.ClassData():newInstance()
window:childAdd(button):alignBottom():margin(40)
button:label():text('click me')
button:onClick(
    function (zfargs)
        zfLog('button clicked: %s', zfargs:sender())
    end)

powerful dynamic register

both lua and cpp can dynamic register class and method

#include "ZFLua.h"
ZFMAIN_ENTRY() {
    ZFDynamic()
        .classBegin("MyBaseView", "ZFUIView")
            .method("void", "testFunc", ZFMP()
                .mp("zfstring", "testParam0")
                , [](const ZFArgs &zfargs) {
                    ZFMethodInvokeData *m = zfargs.param0();
                    zfLogTrim() << m->invokerMethod << " called, param0: " << m->param0;
                })
        .classEnd();

    ZFLuaExecute(
        "ZFDynamic()\n"
        "    :classBegin('MyChildView', 'MyBaseView')\n"
        "        :method('void', 'testFunc', ZFMP()\n"
        "            :mp('zfstring', 'testParam0')\n"
        "            , function(zfargs)\n"
        "                local m = zfargs:param0()\n"
        "                m:callSuper()\n"
        "                zfLogTrim('%s called, param0: %s', m:invokerMethod(), m:param0())\n"
        "            end)\n"
        "    :classEnd()\n"
        "\n"
        "local myView = MyChildView()\n"
        "myView:testFunc('luaParam0')\n"
    );

    zfauto obj = ZFClass::classForName("MyChildView")->newInstance();
    obj->invoke("testFunc", zfobj<v_zfstring>("cppParam0"));

    ZFMethodAlias(ZFMethodForName("MyChildView", "testFunc"), "testAliased");
    ZFLuaExecute(
        "local myView = MyChildView()\n"
        "myView:testAliased('luaParam0')\n"
    );
}

powerful abstract IO

chain http file and zip file, and R/W contents in the zip file just like normal local file

#include "ZFCore.h"
ZFMAIN_ENTRY() {
    ZFResExtPathAdd("ZFCompress:http:http://192.168.xxx.xxx/xxx.zip|");
    ZFInputRead(zfLogTrim(), ZFInputForRes("path/in/zip/file.txt"));
    ZFPathInfoTreePrint(ZFPathInfo("res:"));
}

abstract R/W

#include "ZFCore.h"
ZFMAIN_ENTRY() {
    ZFInputRead(zfLogTrim(), ZFInputForHttp("http://xxx.xxx/xxx.json"));
    zfauto obj = ZFObjectFromJson(ZFInputForHttp("http://xxx.xxx/xxx.json"))
}

Getting started

• Download necessary files
• Setup set up necessary environment for ZFFramework
• Tutorial quick tutorial to code with ZFFramework
• FAQ

Detailed

Requirement

• for the core modlue:

  • C++03 compatible compiler (require templates, no boost/RTTI/exceptions required)
  • STL containers (require: map/unordered_map/vector/deque/list), or supply custom wrapper

• for the implementation module:

  • depends on the actual platform implementation

Main features

• minimum requirement

• powerful reflection, serialzation, styleable logic

  • for how powerful ZFFramework is, you may refer to Feature page
  • automatic lua binding, no extra bind code or config are necessary
  • automatic serialization
  • enhanced global event observer and event filter

• fully modularization, "core + protocol + dynamic implementation" design

  support any platform if you are able to supply a native C++ implementation, most of implementation can be replaced easily and dynamically, all implementation is required only if its owner module being used

• easy to communicate with native code

  even to embed UI elements and native UI elements with each other

License

ZFFramework is under MIT license (see here), feel free to copy or modify or use it

• project home page: http://ZFFramework.com

• repo: https://github.com/ZFFramework/ZFFramework

  Issues or Pull Request are welcome

if you like my work, buy me a coffee?