From 599de8d3f35cb0fe56c7e27591862d61944b456b Mon Sep 17 00:00:00 2001 From: zheng_wenlong Date: Mon, 23 Oct 2017 14:06:12 +0900 Subject: Add a new OnScreenReply api to agl-service-homescreen Add a new event named OnScreenReply. Applications can use this event to reply to the homescreen. Also update the documentation for this event. [Patch Sets 8,9] Update ApplicationGuide.md. For details: Use master source build agl-service-homescreen-2017. Change agl version to EE. Add libhomescreen sample code path. [Patch Sets 10] Delete tailing space. BUG-AGL: SPEC-985 Change-Id: Iea0c321731fa62cd94fc08fc5e303c20847fd525 Signed-off-by: zheng_wenlong --- doc/api-ref/latex/d0/d8a/libhomescreen_8cpp.tex | 147 ++++++------------------ 1 file changed, 34 insertions(+), 113 deletions(-) (limited to 'doc/api-ref/latex/d0/d8a') diff --git a/doc/api-ref/latex/d0/d8a/libhomescreen_8cpp.tex b/doc/api-ref/latex/d0/d8a/libhomescreen_8cpp.tex index 3e7f572..3a824b9 100644 --- a/doc/api-ref/latex/d0/d8a/libhomescreen_8cpp.tex +++ b/doc/api-ref/latex/d0/d8a/libhomescreen_8cpp.tex @@ -12,21 +12,11 @@ {\ttfamily \#include $<$cstdio$>$}\newline {\ttfamily \#include $<$cstdlib$>$}\newline {\ttfamily \#include $<$cstring$>$}\newline -{\ttfamily \#include $<$libhomescreen/libhomescreen.\+hpp$>$}\newline -\subsection*{Macros} -\begin{DoxyCompactItemize} -\item -\#define \hyperlink{libhomescreen_8cpp_a797aa3053bd6a29819d44f8fad8a5eca}{E\+L\+OG}(args, ...)~\hyperlink{libhomescreen_8cpp_af583e7770fe13e35089388a45eaf9d9d}{\+\_\+\+E\+L\+OG}(\+\_\+\+\_\+\+F\+U\+N\+C\+T\+I\+O\+N\+\_\+\+\_\+,\+\_\+\+\_\+\+L\+I\+N\+E\+\_\+\+\_\+,args,\#\#\+\_\+\+\_\+\+V\+A\+\_\+\+A\+R\+G\+S\+\_\+\+\_\+) -\item -\#define \hyperlink{libhomescreen_8cpp_a4e42b2f5af2174dd24f958351becf63d}{D\+L\+OG}(args, ...)~\hyperlink{libhomescreen_8cpp_a7639744c63851d916fb673963e234124}{\+\_\+\+D\+L\+OG}(\+\_\+\+\_\+\+F\+U\+N\+C\+T\+I\+O\+N\+\_\+\+\_\+,\+\_\+\+\_\+\+L\+I\+N\+E\+\_\+\+\_\+,args,\#\#\+\_\+\+\_\+\+V\+A\+\_\+\+A\+R\+G\+S\+\_\+\+\_\+) -\end{DoxyCompactItemize} +{\ttfamily \#include $<$libhomescreen.\+hpp$>$}\newline +{\ttfamily \#include \char`\"{}hmi-\/debug.\+h\char`\"{}}\newline \subsection*{Functions} \begin{DoxyCompactItemize} \item -static void \hyperlink{libhomescreen_8cpp_a7639744c63851d916fb673963e234124}{\+\_\+\+D\+L\+OG} (const char $\ast$func, const int line, const char $\ast$log,...) -\item -static void \hyperlink{libhomescreen_8cpp_af583e7770fe13e35089388a45eaf9d9d}{\+\_\+\+E\+L\+OG} (const char $\ast$func, const int line, const char $\ast$log,...) -\item static bool \hyperlink{libhomescreen_8cpp_a7a2176c3d71fec0f09dcb2aa0866b17e}{has\+\_\+verb} (const string \&verb) \item static void \hyperlink{libhomescreen_8cpp_a73c05b96c151e5e46c28585ccb143c1c}{\+\_\+on\+\_\+hangup\+\_\+static} (void $\ast$closure, struct afb\+\_\+wsj1 $\ast$wsj) @@ -46,76 +36,7 @@ static const char \hyperlink{libhomescreen_8cpp_a1e2d6e77dd8f0162f830058579eab42 \end{DoxyCompactItemize} -\subsection{Macro Definition Documentation} -\mbox{\Hypertarget{libhomescreen_8cpp_a4e42b2f5af2174dd24f958351becf63d}\label{libhomescreen_8cpp_a4e42b2f5af2174dd24f958351becf63d}} -\index{libhomescreen.\+cpp@{libhomescreen.\+cpp}!D\+L\+OG@{D\+L\+OG}} -\index{D\+L\+OG@{D\+L\+OG}!libhomescreen.\+cpp@{libhomescreen.\+cpp}} -\subsubsection{\texorpdfstring{D\+L\+OG}{DLOG}} -{\footnotesize\ttfamily \#define D\+L\+OG(\begin{DoxyParamCaption}\item[{}]{args, }\item[{}]{... }\end{DoxyParamCaption})~\hyperlink{libhomescreen_8cpp_a7639744c63851d916fb673963e234124}{\+\_\+\+D\+L\+OG}(\+\_\+\+\_\+\+F\+U\+N\+C\+T\+I\+O\+N\+\_\+\+\_\+,\+\_\+\+\_\+\+L\+I\+N\+E\+\_\+\+\_\+,args,\#\#\+\_\+\+\_\+\+V\+A\+\_\+\+A\+R\+G\+S\+\_\+\+\_\+)} - - - -Definition at line 33 of file libhomescreen.\+cpp. - -\mbox{\Hypertarget{libhomescreen_8cpp_a797aa3053bd6a29819d44f8fad8a5eca}\label{libhomescreen_8cpp_a797aa3053bd6a29819d44f8fad8a5eca}} -\index{libhomescreen.\+cpp@{libhomescreen.\+cpp}!E\+L\+OG@{E\+L\+OG}} -\index{E\+L\+OG@{E\+L\+OG}!libhomescreen.\+cpp@{libhomescreen.\+cpp}} -\subsubsection{\texorpdfstring{E\+L\+OG}{ELOG}} -{\footnotesize\ttfamily \#define E\+L\+OG(\begin{DoxyParamCaption}\item[{}]{args, }\item[{}]{... }\end{DoxyParamCaption})~\hyperlink{libhomescreen_8cpp_af583e7770fe13e35089388a45eaf9d9d}{\+\_\+\+E\+L\+OG}(\+\_\+\+\_\+\+F\+U\+N\+C\+T\+I\+O\+N\+\_\+\+\_\+,\+\_\+\+\_\+\+L\+I\+N\+E\+\_\+\+\_\+,args,\#\#\+\_\+\+\_\+\+V\+A\+\_\+\+A\+R\+G\+S\+\_\+\+\_\+)} - - - -Definition at line 32 of file libhomescreen.\+cpp. - - - \subsection{Function Documentation} -\mbox{\Hypertarget{libhomescreen_8cpp_a7639744c63851d916fb673963e234124}\label{libhomescreen_8cpp_a7639744c63851d916fb673963e234124}} -\index{libhomescreen.\+cpp@{libhomescreen.\+cpp}!\+\_\+\+D\+L\+OG@{\+\_\+\+D\+L\+OG}} -\index{\+\_\+\+D\+L\+OG@{\+\_\+\+D\+L\+OG}!libhomescreen.\+cpp@{libhomescreen.\+cpp}} -\subsubsection{\texorpdfstring{\+\_\+\+D\+L\+O\+G()}{\_DLOG()}} -{\footnotesize\ttfamily static void \+\_\+\+D\+L\+OG (\begin{DoxyParamCaption}\item[{const char $\ast$}]{func, }\item[{const int}]{line, }\item[{const char $\ast$}]{log, }\item[{}]{... }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}} - - - -Definition at line 545 of file libhomescreen.\+cpp. - - -\begin{DoxyCode} -546 \{ -547 \textcolor{keywordtype}{char} *message; -548 va\_list args; -549 va\_start(args, log); -550 \textcolor{keywordflow}{if} (log == NULL || vasprintf(&message, log, args) < 0) -551 message = NULL; -552 cout << \textcolor{stringliteral}{"[libhomescreen DEBUG]"} << func << \textcolor{stringliteral}{"("} << line << \textcolor{stringliteral}{"):"} << message << endl; -553 va\_end(args); -554 free(message); -555 \} -\end{DoxyCode} -\mbox{\Hypertarget{libhomescreen_8cpp_af583e7770fe13e35089388a45eaf9d9d}\label{libhomescreen_8cpp_af583e7770fe13e35089388a45eaf9d9d}} -\index{libhomescreen.\+cpp@{libhomescreen.\+cpp}!\+\_\+\+E\+L\+OG@{\+\_\+\+E\+L\+OG}} -\index{\+\_\+\+E\+L\+OG@{\+\_\+\+E\+L\+OG}!libhomescreen.\+cpp@{libhomescreen.\+cpp}} -\subsubsection{\texorpdfstring{\+\_\+\+E\+L\+O\+G()}{\_ELOG()}} -{\footnotesize\ttfamily static void \+\_\+\+E\+L\+OG (\begin{DoxyParamCaption}\item[{const char $\ast$}]{func, }\item[{const int}]{line, }\item[{const char $\ast$}]{log, }\item[{}]{... }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}} - - - -Definition at line 533 of file libhomescreen.\+cpp. - - -\begin{DoxyCode} -534 \{ -535 \textcolor{keywordtype}{char} *message; -536 va\_list args; -537 va\_start(args, log); -538 \textcolor{keywordflow}{if} (log == NULL || vasprintf(&message, log, args) < 0) -539 message = NULL; -540 cout << \textcolor{stringliteral}{"[libhomescreen ERROR]"} << func << \textcolor{stringliteral}{"("} << line << \textcolor{stringliteral}{"):"} << message << endl; -541 va\_end(args); -542 free(message); -543 \} -\end{DoxyCode} \mbox{\Hypertarget{libhomescreen_8cpp_a782a05fde0f1c17e0c4c8f972a3f53c8}\label{libhomescreen_8cpp_a782a05fde0f1c17e0c4c8f972a3f53c8}} \index{libhomescreen.\+cpp@{libhomescreen.\+cpp}!\+\_\+on\+\_\+call\+\_\+static@{\+\_\+on\+\_\+call\+\_\+static}} \index{\+\_\+on\+\_\+call\+\_\+static@{\+\_\+on\+\_\+call\+\_\+static}!libhomescreen.\+cpp@{libhomescreen.\+cpp}} @@ -124,13 +45,13 @@ Definition at line 533 of file libhomescreen.\+cpp. -Definition at line 66 of file libhomescreen.\+cpp. +Definition at line 64 of file libhomescreen.\+cpp. \begin{DoxyCode} -67 \{ -68 \textcolor{comment}{/* LibHomeScreen is not called from other process */} -69 \} +65 \{ +66 \textcolor{comment}{/* LibHomeScreen is not called from other process */} +67 \} \end{DoxyCode} \mbox{\Hypertarget{libhomescreen_8cpp_a3df86185aa9453726556da201d95a6f9}\label{libhomescreen_8cpp_a3df86185aa9453726556da201d95a6f9}} \index{libhomescreen.\+cpp@{libhomescreen.\+cpp}!\+\_\+on\+\_\+event\+\_\+static@{\+\_\+on\+\_\+event\+\_\+static}} @@ -140,13 +61,13 @@ Definition at line 66 of file libhomescreen.\+cpp. -Definition at line 71 of file libhomescreen.\+cpp. +Definition at line 69 of file libhomescreen.\+cpp. \begin{DoxyCode} -72 \{ -73 \textcolor{keyword}{static\_cast<}\hyperlink{class_lib_home_screen}{LibHomeScreen}*\textcolor{keyword}{>}(closure)->on\_event(NULL,\hyperlink{structevent}{event},msg); -74 \} +70 \{ +71 \textcolor{keyword}{static\_cast<}\hyperlink{class_lib_home_screen}{LibHomeScreen}*\textcolor{keyword}{>}(closure)->on\_event(NULL,\hyperlink{structevent}{event},msg); +72 \} \end{DoxyCode} \mbox{\Hypertarget{libhomescreen_8cpp_a73c05b96c151e5e46c28585ccb143c1c}\label{libhomescreen_8cpp_a73c05b96c151e5e46c28585ccb143c1c}} \index{libhomescreen.\+cpp@{libhomescreen.\+cpp}!\+\_\+on\+\_\+hangup\+\_\+static@{\+\_\+on\+\_\+hangup\+\_\+static}} @@ -156,13 +77,13 @@ Definition at line 71 of file libhomescreen.\+cpp. websocket -Definition at line 61 of file libhomescreen.\+cpp. +Definition at line 59 of file libhomescreen.\+cpp. \begin{DoxyCode} -62 \{ -63 \textcolor{keyword}{static\_cast<}\hyperlink{class_lib_home_screen}{LibHomeScreen}*\textcolor{keyword}{>}(closure)->on\_hangup(NULL,wsj); -64 \} +60 \{ +61 \textcolor{keyword}{static\_cast<}\hyperlink{class_lib_home_screen}{LibHomeScreen}*\textcolor{keyword}{>}(closure)->on\_hangup(NULL,wsj); +62 \} \end{DoxyCode} \mbox{\Hypertarget{libhomescreen_8cpp_a7778933bffa862c63fa0a1b8219faa8b}\label{libhomescreen_8cpp_a7778933bffa862c63fa0a1b8219faa8b}} \index{libhomescreen.\+cpp@{libhomescreen.\+cpp}!\+\_\+on\+\_\+reply\+\_\+static@{\+\_\+on\+\_\+reply\+\_\+static}} @@ -172,13 +93,13 @@ Definition at line 61 of file libhomescreen.\+cpp. -Definition at line 76 of file libhomescreen.\+cpp. +Definition at line 74 of file libhomescreen.\+cpp. \begin{DoxyCode} -77 \{ -78 \textcolor{keyword}{static\_cast<}\hyperlink{class_lib_home_screen}{LibHomeScreen}*\textcolor{keyword}{>}(closure)->on\_reply(NULL,msg); -79 \} +75 \{ +76 \textcolor{keyword}{static\_cast<}\hyperlink{class_lib_home_screen}{LibHomeScreen}*\textcolor{keyword}{>}(closure)->on\_reply(NULL,msg); +77 \} \end{DoxyCode} \mbox{\Hypertarget{libhomescreen_8cpp_aa73353e1bf62c68b6b0aba7a1e4e275e}\label{libhomescreen_8cpp_aa73353e1bf62c68b6b0aba7a1e4e275e}} \index{libhomescreen.\+cpp@{libhomescreen.\+cpp}!event\+\_\+loop\+\_\+run@{event\+\_\+loop\+\_\+run}} @@ -188,16 +109,16 @@ Definition at line 76 of file libhomescreen.\+cpp. -Definition at line 204 of file libhomescreen.\+cpp. +Definition at line 201 of file libhomescreen.\+cpp. \begin{DoxyCode} -205 \{ -206 \textcolor{keyword}{struct }sd\_event* loop = (\textcolor{keyword}{struct }sd\_event*)(args); -207 \hyperlink{libhomescreen_8cpp_a4e42b2f5af2174dd24f958351becf63d}{DLOG}(\textcolor{stringliteral}{"start eventloop"}); -208 \textcolor{keywordflow}{for}(;;) -209 sd\_event\_run(loop, 30000000); -210 \} +202 \{ +203 \textcolor{keyword}{struct }sd\_event* loop = (\textcolor{keyword}{struct }sd\_event*)(args); +204 \hyperlink{hmi-debug_8h_a0d26d8b8201011dade787236519711c0}{HMI\_DEBUG}(\textcolor{stringliteral}{"libhomescreen"},\textcolor{stringliteral}{"start eventloop"}); +205 \textcolor{keywordflow}{for}(;;) +206 sd\_event\_run(loop, 30000000); +207 \} \end{DoxyCode} \mbox{\Hypertarget{libhomescreen_8cpp_a7a2176c3d71fec0f09dcb2aa0866b17e}\label{libhomescreen_8cpp_a7a2176c3d71fec0f09dcb2aa0866b17e}} \index{libhomescreen.\+cpp@{libhomescreen.\+cpp}!has\+\_\+verb@{has\+\_\+verb}} @@ -207,19 +128,19 @@ Definition at line 204 of file libhomescreen.\+cpp. -Definition at line 557 of file libhomescreen.\+cpp. +Definition at line 518 of file libhomescreen.\+cpp. \begin{DoxyCode} -558 \{ -559 \hyperlink{libhomescreen_8cpp_a4e42b2f5af2174dd24f958351becf63d}{DLOG}(\textcolor{stringliteral}{"verb is %s"}, verb.c\_str()); -560 \textcolor{keywordflow}{if}(find(\hyperlink{class_lib_home_screen_a5593ff5ac78f6495ccb649904cf0ab08}{LibHomeScreen::api\_list}.begin(), +519 \{ +520 \hyperlink{hmi-debug_8h_a0d26d8b8201011dade787236519711c0}{HMI\_DEBUG}(\textcolor{stringliteral}{"libhomescreen"},\textcolor{stringliteral}{"verb is %s"}, verb.c\_str()); +521 \textcolor{keywordflow}{if}(find(\hyperlink{class_lib_home_screen_a5593ff5ac78f6495ccb649904cf0ab08}{LibHomeScreen::api\_list}.begin(), \hyperlink{class_lib_home_screen_a5593ff5ac78f6495ccb649904cf0ab08}{LibHomeScreen::api\_list}.end(), verb) != \hyperlink{class_lib_home_screen_a5593ff5ac78f6495ccb649904cf0ab08}{LibHomeScreen::api\_list}.end()) -561 \textcolor{keywordflow}{return} \textcolor{keyword}{true}; -562 \textcolor{keywordflow}{else} -563 \textcolor{keywordflow}{return} \textcolor{keyword}{false}; -564 \} +522 \textcolor{keywordflow}{return} \textcolor{keyword}{true}; +523 \textcolor{keywordflow}{else} +524 \textcolor{keywordflow}{return} \textcolor{keyword}{false}; +525 \} \end{DoxyCode} @@ -232,5 +153,5 @@ Definition at line 557 of file libhomescreen.\+cpp. -Definition at line 40 of file libhomescreen.\+cpp. +Definition at line 36 of file libhomescreen.\+cpp. -- cgit 1.2.3-korg