element. Other than this, it should behave identical
- * to EmbAJAXContainer.
+ * to EmbAJAXElementList.
*
- * You do _not_ need this class to hide an EmbAJAXContainer that contains only EmbAJAXElement
+ * You do _not_ need this class to hide an EmbAJAXElementList that contains only EmbAJAXElement
* derived objects, or standalone EmbAJAXElement objects.
*
- * @note This is _not_ a derived class of EmbAJAXContainer, to avoid adding virtual
+ * @note This is _not_ a derived class of EmbAJAXElementList, to avoid adding virtual
* inheritance just for this. */
-template
class EmbAJAXHideableContainer : public EmbAJAXElement {
+class EmbAJAXHideableContainer : public EmbAJAXElement {
public:
- EmbAJAXHideableContainer(const char* id, EmbAJAXBase *children[NUM]) : EmbAJAXElement(id) {
- _childlist = EmbAJAXContainer(children);
- }
+ template constexpr EmbAJAXHideableContainer(const char* id, EmbAJAXBase *(&children)[NUM]) : EmbAJAXElement(id), _childlist(children) {}
void print() const override {
_driver->printFormatted("");
_childlist.print();
_driver->printContent("
");
}
+ /** constructor taking an array of elements with a size that cannot be determined at compile time. In this case, you'll have to specify the size, as the first parameter */
+ constexpr EmbAJAXHideableContainer(const char* id, size_t childcount, EmbAJAXBase* const* children) : EmbAJAXElement(id), _childlist(childcount, children) {}
+ /** constructor taking list of pointers to elements */
+ template constexpr EmbAJAXHideableContainer(const char* id, T*... elements) : EmbAJAXElement(id), _childlist(elements...) {}
+
EmbAJAXElement* findChild(const char* id) const override {
return _childlist.findChild(id);
}
@@ -608,38 +645,40 @@ template class EmbAJAXHideableContainer : public EmbAJAXElement {
EmbAJAXElement::setBasicProperty(num, status);
_childlist.setBasicProperty(num, status);
}
- EmbAJAXContainer _childlist;
+ EmbAJAXElementList _childlist;
};
/** @brief A set of radio buttons (mutally exclusive buttons), e.g. for on/off, or low/mid/high, etc.
*
- * You can insert either the whole group into an EmbAJAXPage at once, or - for more flexbile
- * layouting - retrieve the individual buttons using() button, and insert them into the page
- * as independent elements. */
-template class EmbAJAXRadioGroup : public EmbAJAXContainer, public EmbAJAXRadioGroupBase {
+ * Note: This class is provided to keep old code working, but will be removed in the future.
+ * You can use all members of this class, but please instantiate it as EmbAJAXRadioGroup.
+ */
+class EmbAJAXRadioGroupImpl : public EmbAJAXElementList {
public:
- /** ctor.
- * @param id_base the "base" id. Internally, radio buttons with id_s id_base0, id_base1, etc. will be created.
- * @param options labels for the options. Note: The @em array of options may be a temporary, but the option-strings themselves will have to be persistent!
- * @param selected_option index of the default option. 0 by default, for the first option, may be > NUM, for
- * no option selected by default. */
- EmbAJAXRadioGroup(const char* id_base, const char* options[NUM], uint8_t selected_option = 0) : EmbAJAXContainer(), EmbAJAXRadioGroupBase() {
- for (uint8_t i = 0; i < NUM; ++i) {
+ EmbAJAXRadioGroupImpl(const char* id_base, int8_t N_options, const char** options, uint8_t selected_option = 0) : EmbAJAXElementList(N_options) {
+ auto buttons = new EmbAJAXBase*[N_options];
+ childids = new char[N_options][EMBAJAX_MAX_ID_LEN]; // NOTE: this could be RAM optimized
+ for (uint8_t i = 0; i < N_options; ++i) {
char* childid = childids[i];
strncpy(childid, id_base, EMBAJAX_MAX_ID_LEN-4);
itoa(i, &(childid[strlen(childid)]), 10);
- buttons[i] = EmbAJAXCheckButton(childid, options[i], i == selected_option);
- buttons[i].radiogroup = this;
- buttonpointers[i] = &buttons[i];
+ auto button = new EmbAJAXCheckButton(childid, options[i], i == selected_option);
+ button->radiogroup = this;
+ buttons[i] = button;
}
_current_option = selected_option;
- EmbAJAXContainer::_children = buttonpointers; // Hm, why do I need to specify EmbAJAXContainer::, explicitly?
+ _children = buttons;
_name = id_base;
- }
+ }/*
+ ~EmbAJAXRadioGroup() {
+ for (uint8_t i = 0; i < NUM; ++i) delete _children[i];
+ delete _children;
+ delete childids;
+ }*/
/** Select / check the option at the given index. All other options in this radio group will become deselected. */
void selectOption(uint8_t num) {
for (uint8_t i = 0; i < NUM; ++i) {
- buttons[i].setChecked(i == num);
+ static_cast(static_cast(_children[i]))->setChecked(i == num);
}
_current_option = num; // NOTE: might be outside of range, but that's ok, signifies "none selected"
}
@@ -650,26 +689,63 @@ template class EmbAJAXRadioGroup : public EmbAJAXContainer, pub
/** @returns a representation of an individual option element. You can use this to insert the individual buttons
* at arbitrary positions in the page layout. */
EmbAJAXBase* button(uint8_t num) {
- if (num < NUM) return (&buttons[num]);
- return 0;
+ if (num < NUM) return (_children[num]);
+ return nullptr;
}
private:
- EmbAJAXCheckButton buttons[NUM]; /** NOTE: Internally, the radio groups allocates individual check buttons. This is the storage space for those. */
- EmbAJAXBase* buttonpointers[NUM];
- char childids[NUM][EMBAJAX_MAX_ID_LEN];
+friend class EmbAJAXCheckButton;
+ const char* _name;
+ typedef char idstring[EMBAJAX_MAX_ID_LEN];
+ idstring *childids; /** NOTE: Child ids are not copied by EmbAJAXElement. This is the storage space for them */
+ // TODO: Can we remove those, by using a recursive lookup scheme, instead? (groupid.buttonid)
int8_t _current_option;
- void selectButton(EmbAJAXCheckButton* which) override {
+ void selectButton(EmbAJAXCheckButton* which) {
_current_option = -1;
for (uint8_t i = 0; i < NUM; ++i) {
- if (which == buttonpointers[i]) {
+ if (which == _children[i]) {
_current_option = i;
} else {
- buttons[i].setChecked(false);
+ static_cast(static_cast(_children[i]))->setChecked(false);
}
}
}
};
+/** @brief A set of radio buttons (mutally exclusive buttons), e.g. for on/off, or low/mid/high, etc.
+ *
+ * You can insert either the whole group into an EmbAJAXPage at once, or - for more flexbile
+ * layouting - retrieve the individual buttons using button(), and insert them into the page
+ * as independent elements.
+ *
+ * Note: Template parameter is retained for backwards compatility, only, and will be removed in a future release.
+ * Almost all member functions are defined in EmbAJAXRadioGroupImpl, for the same reason. In new code, you should
+ * still use EmbAJAXRadioGroup, but _without_ any template parameter specified. Eventually, EmbAJAXRadioGroupImpl
+ * will be merged into this class, and your code will continue working, unchanged.
+ *
+ * Do _not_ specifiy a template parameter.
+ */
+template class EmbAJAXRadioGroup : public EmbAJAXRadioGroupImpl {
+public:
+ /** ctor.
+ * @param id_base the "base" id. Internally, radio buttons with ids id_base0, id_base1, etc. will be created.
+ * @param options labels for the options. Note: The @em array of options may be a temporary, but the option-strings themselves will have to be persistent!
+ * @param selected_option index of the default option. 0 by default, for the first option, may be > NUM, for
+ * no option selected by default. */
+ EMBAJAX_DEPRECATED("v0.3.0", "Use template free constructor, instead") EmbAJAXRadioGroup(const char* id_base, const char* options[N], uint8_t selected_option = 0) : EmbAJAXRadioGroupImpl(id_base, N, options, selected_option) {};
+ EMBAJAX_DEPRECATED("v0.3.0", "Use EmbAJAXRadioGroup without specifying a template parameter") EmbAJAXRadioGroup(const char* id_base, int8_t N_options, const char** options, uint8_t selected_option = 0) : EmbAJAXRadioGroupImpl(id_base, N_options, options, selected_option) {};
+};
+
+/* Specialization in order not to nag about template parameter, when none is specified. */
+template<> class EmbAJAXRadioGroup<0> : public EmbAJAXRadioGroupImpl {
+public:
+ /** ctor.
+ * @param id_base the "base" id. Internally, radio buttons with ids id_base0, id_base1, etc. will be created.
+ * @param options labels for the options. Note: The @em array of options may be a temporary, but the option-strings themselves will have to be persistent!
+ * @param selected_option index of the default option. 0 by default, for the first option, may be > NUM, for
+ * no option selected by default. */
+ EmbAJAXRadioGroup(const char* id_base, int8_t N_options, const char** options, uint8_t selected_option = 0) : EmbAJAXRadioGroupImpl(id_base, N_options, options, selected_option) {};
+};
+
/** @brief Abstract base class for EmbAJAXOptionSelect. */
class EmbAJAXOptionSelectBase : public EmbAJAXElement {
public:
@@ -710,39 +786,49 @@ template class EmbAJAXOptionSelect : public EmbAJAXOptionSelectBase
const char* _labels[NUM];
};
-/** @brief Absrract internal helper class
- *
- * Needed for internal reasons. Refer to EmbAJAXPage, instead. */
-class EmbAJAXPageBase {
-public:
- virtual void handleRequest(void (*change_callback)()=0) = 0;
- virtual void printPage() = 0;
-};
-
/** @brief The main interface class
*
* This is the main interface class. Create a web-page with a list of elements on it, and arrange for
* print() (for page loads) adn handleRequest() (for AJAX calls) to be called on requests. By default,
* both page loads, and AJAX are handled on the same URL, but the first via GET, and the second
* via POST. */
-template class EmbAJAXPage : public EmbAJAXContainer, public EmbAJAXPageBase {
+class EmbAJAXPage : public EmbAJAXElementList {
public:
+ /** @See EmbAJAXPage(). Struct to encapsulate the constructor arguments. */
+ struct Params {
+ constexpr Params(const char* title = null_string, const char* header_add = null_string, uint16_t min_interval=100) : title(title), header_add(header_add), min_interval(min_interval){};
+ const char* title;
+ const char* header_add;
+ uint16_t min_interval;
+ };
+
/** Create a web page.
* @param children list of elements on the page
* @param title title (may be 0). This string is not copied, please do not use a temporary string.
- * @param header_add literal text (may be 0) to be added to the header, e.g. CSS (linked or in-line). This string is not copied, please do not use a temporary string).
+ * @param header_add literal text (may be 0) to be added to the header, e.g. CSS (linked or in-line). This string is not copied, please do not use a temporary string).
* @param min_interval minimum interval (ms) between two requests sent by a single client. A lower value may reduce latency at the cost of traffic/CPU. */
- EmbAJAXPage(EmbAJAXBase* children[NUM], const char* title, const char* header_add = 0, uint16_t min_interval=100) : EmbAJAXContainer(children),
- _title(title ? title : EmbAJAXBase::null_string), _header_add(header_add ? header_add : EmbAJAXBase::null_string), _min_interval(min_interval) {}
- /** Duplication of print(), needed for internal reasons. Use print(), instead! */
- void printPage() override {
+ template constexpr EmbAJAXPage(EmbAJAXBase* (&children)[NUM], const char* title, const char* header_add = 0, uint16_t min_interval=100) :
+ EmbAJAXElementList(children), p(Params(title, header_add, min_interval)) {}
+ /** constructor taking an array of elements with a size that cannot be determined at compile time.
+ * @param childcount Number of elements
+ * @param children array of pointer to elements.
+ * For the other parameters, see above. */
+ constexpr EmbAJAXPage(size_t childcount, EmbAJAXBase* const* children, const char* title, const char* header_add = 0, uint16_t min_interval=100) :
+ EmbAJAXElementList(childcount, children), p(Params(title, header_add, min_interval)) {}
+ /** constructor taking list of pointers to elements.
+ * @param p page parameters. These are the same as in the other constructors, but encapsulated into a struct to allow for future expansion.
+ * @param elements page elements. These are passed as either EmbAJAXBase* or as contant strings. The latter are wrapped into
+ * EmbAJAXStatic, automatically.
+ */
+ template constexpr EmbAJAXPage(Params p, T*... elements) : EmbAJAXElementList(elements...), p(p) {}
+
+ /** Duplication of print(), historically needed for internal reasons. Use print(), instead! */
+ EMBAJAX_DEPRECATED("v0.3.0", "Use print(), instead") void printPage() const {
print();
- }
+ };
/** Serve the page including headers and all child elements. You should arrange for this function to be called, whenever
* there is a GET request to the desired URL. */
- void print() const override {
- EmbAJAXBase::printPage(EmbAJAXContainer::_children, NUM, _title, _header_add, _min_interval);
- }
+ void print() const override;
/** Handle AJAX client request. You should arrange for this function to be called, whenever there is a POST request
* to whichever URL you served the page itself, from.
*
@@ -751,10 +837,7 @@ template class EmbAJAXPage : public EmbAJAXContainer, public Em
* response to the change, you should specify this function, and handle the change inside it.
* This way, an update can be sent back to the client, immediately, for a smooth UI experience.
* (Otherwise the client will be updated on the next poll). */
- void handleRequest(void (*change_callback)()=0) override {
- _latest_ping = millis();
- EmbAJAXBase::handleRequest(EmbAJAXContainer::_children, NUM, change_callback);
- }
+ void handleRequest(void (*change_callback)()=0);
/** Returns true if a client seems to be connected (connected clients should send a ping at least once per second; by default this
* function returns whether a ping has been seen within the last 5000 ms.
* @param latency_ms Number of milliseconds to consider as maximum silence period for an active connection */
@@ -762,9 +845,7 @@ template class EmbAJAXPage : public EmbAJAXContainer, public Em
return(_latest_ping && (_latest_ping + latency_ms > millis()));
}
protected:
- const char* _title;
- const char* _header_add;
- uint16_t _min_interval;
+ Params p;
uint64_t _latest_ping = 0;
};
diff --git a/EmbAJAXOutputDriverESPAsync.h b/EmbAJAXOutputDriverESPAsync.h
index 38bf6bd..6ecd3f0 100644
--- a/EmbAJAXOutputDriverESPAsync.h
+++ b/EmbAJAXOutputDriverESPAsync.h
@@ -56,14 +56,14 @@ class EmbAJAXOutputDriverESPAsync : public EmbAJAXOutputDriverBase {
_request->arg(name).toCharArray (buf, buflen);
return buf;
}
- void installPage(EmbAJAXPageBase *page, const char *path, void (*change_callback)()=0) override {
+ void installPage(EmbAJAXPage *page, const char *path, void (*change_callback)()=0) override {
_server->on(path, [=](AsyncWebServerRequest* request) {
_request = request;
_response = 0;
if (_request->method() == HTTP_POST) { // AJAX request
page->handleRequest(change_callback);
} else { // Page load
- page->printPage();
+ page->print();
}
_request->send(_response);
_request = 0;
diff --git a/EmbAJAXOutputDriverGeneric.h b/EmbAJAXOutputDriverGeneric.h
index 9406bc5..4050646 100644
--- a/EmbAJAXOutputDriverGeneric.h
+++ b/EmbAJAXOutputDriverGeneric.h
@@ -58,12 +58,12 @@ class EmbAJAXOutputDriverGeneric : public EmbAJAXOutputDriverBase {
_server->arg(name).toCharArray (buf, buflen);
return buf;
}
- void installPage(EmbAJAXPageBase *page, const char *path, void (*change_callback)()=0) override {
+ void installPage(EmbAJAXPage *page, const char *path, void (*change_callback)()=0) override {
_server->on(path, [=]() {
if (_server->method() == HTTP_POST) { // AJAX request
page->handleRequest(change_callback);
} else { // Page load
- page->printPage();
+ page->print();
}
});
}
diff --git a/README.md b/README.md
index 2af8d5e..889f1f4 100644
--- a/README.md
+++ b/README.md
@@ -64,6 +64,7 @@ The following additional features may be of interest (supported as of now):
- Allows to insert your own custom CSS for styling (no styling in the lib).
- See the "Styling"-example for techniques that can be used to define styling
- Elements can be hidden, inputs can be disabled from the server (EmbAJAXBase::setVisible(), setEnabled()).
+- Support for developing custom controls in client-side javascript (EmbAJAXScriptedSpan)
### Hardware support
diff --git a/docs/ChangeLog.md b/docs/ChangeLog.md
index 24bd900..3c7b1df 100644
--- a/docs/ChangeLog.md
+++ b/docs/ChangeLog.md
@@ -1,4 +1,7 @@
-- Changes in version 0.3.0 -- UNRELEASED
+x TODO: Adjust radio group, option select
+X TODO: Clean up
+x TODO: More constexpr c'tors
X TODO: Fix EmbAJAXValidatingTextInput (did it ever work?)
-- Changes in version 0.2.0 -- 2023-04-29
diff --git a/examples/Styling/Styling.ino b/examples/Styling/Styling.ino
index 95d6cf9..07c07d6 100644
--- a/examples/Styling/Styling.ino
+++ b/examples/Styling/Styling.ino
@@ -84,11 +84,11 @@ MAKE_EmbAJAXPage(page, "EmbAJAX example - Styling",
new EmbAJAXPushButton("my_button1", "Nothing", handleButton),
new EmbAJAXPushButton("my_button2", "Round", handleButton),
new EmbAJAXPushButton("my_button3", "Nothing", handleButton),
- new EmbAJAXHideableContainer<3> ("my_div", new EmbAJAXBase*[3] {
- new EmbAJAXStatic("White on black
"),
+ new EmbAJAXHideableContainer ("my_div",
+ "White on black
",
new EmbAJAXPushButton("my_button4", "Nothing", handleButton),
- new EmbAJAXPushButton("my_button5", "Nothing", handleButton),
- }),
+ new EmbAJAXPushButton("my_button5", "Nothing", handleButton)
+ ),
new EmbAJAXStatic("Styling examples for other elements
"),
new EmbAJAXCheckButton("my_checkbox", "Checkbox control with custom box moved to the right-hand side"),
new EmbAJAXStatic("A short slider oriented vertically
"),
diff --git a/examples/Visibility/Visibility.ino b/examples/Visibility/Visibility.ino
index 1eab1e3..6c02466 100644
--- a/examples/Visibility/Visibility.ino
+++ b/examples/Visibility/Visibility.ino
@@ -37,10 +37,10 @@ void buttonPressed(EmbAJAXPushButton*) { }
EmbAJAXPushButton button("button", "I can count", buttonPressed);
EmbAJAXBase* container1_contents[] = {&statics[0], &check, &statics[1], &optionselect, &statics[2], &slider, &statics[3]};
-EmbAJAXContainer<7> container1(container1_contents);
+EmbAJAXElementList container1(container1_contents);
EmbAJAXBase* container2_contents[] = {&statics[0], &button, &statics[1], &text, &statics[2], &radio, &statics[3]};
-EmbAJAXHideableContainer<7> container2("hideable", container2_contents);
+EmbAJAXHideableContainer container2("hideable", container2_contents);
// Define the page
MAKE_EmbAJAXPage(page, "EmbAJAX example - Visibility", "",
diff --git a/macro_definitions.h b/macro_definitions.h
index ea33455..f176d22 100644
--- a/macro_definitions.h
+++ b/macro_definitions.h
@@ -121,6 +121,16 @@
#define printF_proxy(X, ...) _printContentF(X, __VA_ARGS__);
#endif
+#if __cplusplus >= 201402L
+#define EMBAJAX_DEPRECATED(WHEN, WHY) [[deprecated(WHY)]]
+#elif defined(__GNUC__) || defined(__clang__)
+#define EMBAJAX_DEPRECATED(WHEN, WHY) __attribute__((deprecated))
+#elif defined(_MSC_VER)
+#define EMBAJAX_DEPRECATED(WHEN, WHY) __declspec(deprecated)
+#else
+#define EMBAJAX_DEPRECATED(WHEN, WHY)
+#endif
+
#ifndef UNUSED
#define UNUSED(X) (void)(sizeof(X))
#endif