From b53c64821214852ee2553040c68ab42a27a9cc03 Mon Sep 17 00:00:00 2001 From: Elias Castegren Date: Fri, 30 Jan 2015 08:40:57 +0100 Subject: [PATCH 001/172] Runtime types generated for passive classes, futures and streams Streams and futures also have trace functions (and therefore need to store the type of their elements). --- src/back/CodeGen/CCodeNames.hs | 7 ++++++ src/back/CodeGen/ClassDecl.hs | 42 +++++++++++++++++++--------------- src/back/CodeGen/Expr.hs | 18 ++++++++------- src/back/CodeGen/Header.hs | 7 ++++++ src/back/CodeGen/Type.hs | 10 +++++++- src/runtime/future/future.c | 32 +++++++++++++++++++++++++- src/runtime/future/future.h | 5 +++- src/runtime/stream/stream.c | 32 +++++++++++++++++++++----- src/runtime/stream/stream.h | 5 ++-- 9 files changed, 120 insertions(+), 38 deletions(-) diff --git a/src/back/CodeGen/CCodeNames.hs b/src/back/CodeGen/CCodeNames.hs index 936aad525..cf9c59d96 100644 --- a/src/back/CodeGen/CCodeNames.hs +++ b/src/back/CodeGen/CCodeNames.hs @@ -23,6 +23,7 @@ uint = Typ "uint64_t" bool = Typ "int64_t" -- For pony argument tag compatibility. Should be changed to something smaller double = Typ "double" void = Typ "void" +pony_type_t = Typ "pony_type_t" pony_actor_t = Typ "pony_actor_t" pony_actor_type_t = Typ "pony_actor_type_t" pony_arg_t = Typ "pony_arg_t" @@ -95,3 +96,9 @@ data_rec_ptr = Ptr . data_rec_type actor_rec_name :: Ty.Type -> CCode Name actor_rec_name clazz = Nam $ Ty.getId clazz ++ "_actor" + +type_rec_name :: Ty.Type -> CCode Name +type_rec_name clazz = Nam $ Ty.getId clazz ++ "_type" + +future_type_rec_name :: CCode Name +future_type_rec_name = Nam $ "future_type" \ No newline at end of file diff --git a/src/back/CodeGen/ClassDecl.hs b/src/back/CodeGen/ClassDecl.hs index 5decb37c4..d8700dc30 100644 --- a/src/back/CodeGen/ClassDecl.hs +++ b/src/back/CodeGen/ClassDecl.hs @@ -83,23 +83,18 @@ translateActiveClass cdecl@(A.Class{A.cname, A.fields, A.methods}) = (Decl (Static (Typ "pony_msg_t"), (method_message_type_name cname (A.mname mdecl)))) (if (A.isMainClass cdecl) && (A.mname mdecl == ID.Name "main") then - (Record - [Int $ length (A.mparams mdecl), - Record $ map (pony_mode . A.getType) (A.mparams mdecl)]) + (Record + [Int $ length (A.mparams mdecl), + Record $ map (runtime_type . A.getType) (A.mparams mdecl)]) else (Record [Int $ length (A.mparams mdecl) + 1, -- plus 1 for future argument - Record $ Nam "PONY_NONE" : map (pony_mode . A.getType) (A.mparams mdecl)])), - AssignTL - (Decl (Static (Typ "pony_msg_t"), + Record $ Amp future_type_rec_name : map (runtime_type . A.getType) (A.mparams mdecl)])), + AssignTL + (Decl (Static (Typ "pony_msg_t"), one_way_message_type_name cname (A.mname mdecl))) - (Record [Int $ length (A.mparams mdecl), - Record $ map (pony_mode . A.getType) (A.mparams mdecl)])] - - pony_mode ty = - case translate ty of - Ptr (Typ "pony_actor_t") -> Nam "PONY_ACTOR" - _other -> Nam "PONY_NONE" + (Record [Int $ length (A.mparams mdecl), + Record $ map (runtime_type . A.getType) (A.mparams mdecl)])] message_type_decl :: CCode Toplevel message_type_decl = @@ -207,7 +202,7 @@ translateActiveClass cdecl@(A.Class{A.cname, A.fields, A.methods}) = then [one_way_send_dispatch_clause m] else [] - mthd_dispatch_clause mdecl@(A.Method{A.mname, A.mparams}) = + mthd_dispatch_clause mdecl@(A.Method{A.mname, A.mparams, A.mtype}) = (method_msg_name cname mname, Seq [Assign (Decl (Ptr $ Typ "future_t", Var "fut")) ((ArrAcc 0 ((Var "argv"))) `Dot` (Nam "p")), @@ -221,10 +216,10 @@ translateActiveClass cdecl@(A.Class{A.cname, A.fields, A.methods}) = (method_msg_name cname mname, Seq [Assign (Decl (Ptr $ Typ "future_t", Var "fut")) ((ArrAcc 0 ((Var "argv"))) `Dot` (Nam "p")), - Statement $ (Call (method_impl_name cname mname) + Statement $ Call (method_impl_name cname mname) ((AsExpr . Var $ "p") : (AsExpr . Var $ "fut") : - (paramdecls_to_argv 1 $ mparams)))]) + (paramdecls_to_argv 1 $ mparams))]) one_way_send_dispatch_clause mdecl@A.Method{A.mname, A.mparams} = (one_way_send_msg_name cname mname, @@ -251,11 +246,11 @@ translateActiveClass cdecl@(A.Class{A.cname, A.fields, A.methods}) = (AssignTL (Decl (Typ "pony_actor_type_t", AsLval $ actor_rec_name cname)) (Record [AsExpr . AsLval . Nam $ ("ID_"++(Ty.getId cname)), - tracefun_rec, + pony_type_t_rec, AsExpr . AsLval $ class_message_type_name cname, AsExpr . AsLval $ class_dispatch_name cname])) where - tracefun_rec = + pony_type_t_rec = Record [Call (Nam "sizeof") [Var . show $ data_rec_name cname], AsExpr . AsLval $ (class_trace_fn_name cname), Null, @@ -269,7 +264,9 @@ translatePassiveClass cdecl@(A.Class{A.cname, A.fields, A.methods}) = Program $ Concat $ (LocalInclude "header.h") : [tracefun_decl] ++ - method_impls + method_impls ++ + [pony_type_t_impl] + where tracefun_decl :: CCode Toplevel tracefun_decl = @@ -295,3 +292,10 @@ translatePassiveClass cdecl@(A.Class{A.cname, A.fields, A.methods}) = method_impls = map method_decl methods where method_decl mdecl = translate mdecl cdecl + + pony_type_t_impl = + (AssignTL (Decl (Typ "pony_type_t", AsLval $ type_rec_name cname)) + (Record [Call (Nam "sizeof") [Var . show $ data_rec_name cname], + AsExpr . AsLval $ (class_trace_fn_name cname), + Null, + Null])) diff --git a/src/back/CodeGen/Expr.hs b/src/back/CodeGen/Expr.hs index 5e5a0ddc1..1ef62436e 100644 --- a/src/back/CodeGen/Expr.hs +++ b/src/back/CodeGen/Expr.hs @@ -227,20 +227,20 @@ instance Translatable A.Expr (State Ctx.Context (CCode Lval, CCode Stat)) where remote_call :: State Ctx.Context (CCode Lval, CCode Stat) remote_call = - do ttarget <- varaccess_this_to_aref target + do (ntarget, ttarget) <- translate target targs <- mapM varaccess_this_to_aref args let argtys = (map A.getType args) - let targtys = map (translate . A.getType) args :: [CCode Ty] + targtys = map (translate . A.getType) args :: [CCode Ty] the_fut_name <- if Ty.isStreamType $ A.getType call then Ctx.gen_named_sym "stream" else Ctx.gen_named_sym "fut" let the_fut_decl = if Ty.isStreamType $ A.getType call then Assign (Decl (Ptr $ Typ "stream_t", Var the_fut_name)) - (Call (Nam "stream_mk") ([] :: [CCode Lval])) + (Call (Nam "stream_mk") ([] :: [CCode Expr])) else Assign (Decl (Ptr $ Typ "future_t", Var the_fut_name)) - (Call (Nam "future_mk") ([] :: [CCode Lval])) + (Call (Nam "future_mk") ([runtime_type $ A.getType call])) the_arg_name <- Ctx.gen_named_sym "arg" let the_arg_decl = Assign (Decl (Typ "pony_arg_t", ArrAcc (1 + length args) (Var the_arg_name))) @@ -249,12 +249,12 @@ instance Translatable A.Expr (State Ctx.Context (CCode Lval, CCode Stat)) where (map (\(arg, ty) -> UnionInst (pony_arg_t_tag ty) arg) (zip targs targtys)) :: [CCode Expr])) the_call <- return (Call (Nam "pony_sendv") - [ttarget, + [AsExpr ntarget, AsExpr . AsLval $ method_msg_name (A.getType target) name, Int $ 1 + length args, AsExpr $ Var the_arg_name]) return (Var the_fut_name, - Seq [ + Seq [ttarget, the_fut_decl, the_arg_decl, Statement the_call]) @@ -380,10 +380,12 @@ instance Translatable A.Expr (State Ctx.Context (CCode Lval, CCode Stat)) where translate yield@(A.Yield{A.val}) = do (nval, tval) <- translate val + tmp <- Ctx.gen_sym let yield_arg = Cast pony_arg_t $ UnionInst (pony_arg_t_tag (translate (A.getType val))) nval + tmp_stream = Assign (Decl (stream, Var tmp)) stream_handle update_stream = Assign (stream_handle) (Call (Nam "stream_put") - [AsExpr stream_handle, yield_arg]) - return (unit, Seq [tval, update_stream]) + [AsExpr stream_handle, yield_arg, runtime_type $ A.getType val]) + return (unit, Seq [tval, tmp_stream, update_stream]) translate eos@(A.Eos{}) = let eos_call = Call (Nam "stream_close") [stream_handle] diff --git a/src/back/CodeGen/Header.hs b/src/back/CodeGen/Header.hs index 56077b5eb..aef3ac546 100644 --- a/src/back/CodeGen/Header.hs +++ b/src/back/CodeGen/Header.hs @@ -67,6 +67,9 @@ generate_header A.Program{A.etl = A.EmbedTL{A.etlheader}, A.functions, A.classes [comment_section "Actor types"] ++ actor_decls ++ + [comment_section "Passive class types"] ++ + type_decls ++ + [comment_section "Methods"] ++ concatMap method_fwds classes where @@ -124,6 +127,10 @@ generate_header A.Program{A.etl = A.EmbedTL{A.etlheader}, A.functions, A.classes where actor_decl A.Class{A.cname} = DeclTL (pony_actor_type_t, AsLval $ actor_rec_name cname) + type_decls = map type_decl $ filter (not . A.isActive) classes + where + type_decl A.Class{A.cname} = DeclTL (pony_type_t, AsLval $ type_rec_name cname) + method_fwds cdecl@(A.Class{A.cname, A.methods}) = map method_fwd methods where method_fwd A.Method{A.mtype, A.mname, A.mparams} = diff --git a/src/back/CodeGen/Type.hs b/src/back/CodeGen/Type.hs index fc40806e2..37bb0f700 100644 --- a/src/back/CodeGen/Type.hs +++ b/src/back/CodeGen/Type.hs @@ -35,4 +35,12 @@ instance Translatable Ty.Type (CCode Ty) where | Ty.isTypeVar ty = Ptr void | Ty.isFutureType ty = future | Ty.isStreamType ty = stream - | otherwise = error $ "I don't know how to translate "++ show ty ++" to pony.c" \ No newline at end of file + | otherwise = error $ "I don't know how to translate "++ show ty ++" to pony.c" + +runtime_type :: Ty.Type -> CCode Expr +runtime_type ty + | Ty.isActiveRefType ty = AsExpr $ Var "PONY_ACTOR" + | Ty.isPassiveRefType ty = Amp $ type_rec_name ty + | Ty.isFutureType ty || + Ty.isStreamType ty = Amp $ future_type_rec_name + | otherwise = AsExpr $ Var "PONY_NONE" \ No newline at end of file diff --git a/src/runtime/future/future.c b/src/runtime/future/future.c index ea896e6cd..84f948994 100644 --- a/src/runtime/future/future.c +++ b/src/runtime/future/future.c @@ -72,6 +72,7 @@ struct actor_entry struct future { void *value; + pony_type_t *type; bool fulfilled; // Stupid limitation for now actor_entry_t responsibilities[16]; @@ -83,10 +84,38 @@ struct future closure_entry_t *children; }; +pony_type_t future_type = {sizeof(struct future), future_trace, NULL, NULL}; + +pony_type_t *future_get_type(future_t *fut){ + return fut->type; +} + +void future_trace(void *p) +{ + future_t *fut = (future_t *) p; + if(future_fulfilled(fut)){ // Should the tracer need to block on the future? + if(fut->type == PONY_NONE){ +// pony_trace(p); + }else if (fut->type == PONY_ACTOR){ + pony_traceactor(fut->value); + }else{ + pony_traceobject(fut->value, fut->type->trace); + } + } + // TODO: Who traces whom? + for(int i = 0; i < fut->no_responsibilities; i++){ + pony_traceactor(fut->responsibilities[i].message.actor); + } + closure_entry_t *cursor = fut->children; + while(cursor != NULL){ + pony_traceobject(cursor->future, future_trace); + } +} + // =============================================================== // Create, inspect and fulfil // =============================================================== -future_t *future_mk(void) +future_t *future_mk(pony_type_t *type) { perr("future_mk"); @@ -94,6 +123,7 @@ future_t *future_mk(void) // TODO: figure out if this is necessary, of if memory is already 0'd *fut = (future_t) {}; // fut->parent = NULL; + fut->type = type; return fut; } diff --git a/src/runtime/future/future.h b/src/runtime/future/future.h index f0d3633c6..90edfbd54 100644 --- a/src/runtime/future/future.h +++ b/src/runtime/future/future.h @@ -6,10 +6,13 @@ typedef struct future future_t; +extern pony_type_t future_type; +void future_trace(void *); +pony_type_t *future_get_type(future_t *fut); // =============================================================== // Create, inspect and fulfil // =============================================================== -future_t *future_mk(void); +future_t *future_mk(pony_type_t *type); bool future_fulfilled (future_t *fut); void *future_read_value (future_t *fut); void future_fulfil (future_t *fut, void *value); diff --git a/src/runtime/stream/stream.c b/src/runtime/stream/stream.c index 3f562e15c..65daaa584 100644 --- a/src/runtime/stream/stream.c +++ b/src/runtime/stream/stream.c @@ -5,13 +5,32 @@ struct scons{ bool eos; pony_arg_t element; + pony_type_t *type; stream_t *next; }; -static struct scons *scons_mk(){ +void scons_trace(void *p){ + struct scons *scons = p; + if(!scons->eos){ + pony_type_t *type = scons->type; + if(type == PONY_NONE){ +// pony_trace(scons->element.p); + } else if (type == PONY_ACTOR){ + pony_traceactor(scons->element.p); + } else{ + pony_traceobject(scons->element.p, type->trace); + } + pony_traceobject(scons->next, future_trace); + } +} + +pony_type_t scons_type = {sizeof(struct scons), scons_trace, NULL, NULL}; + +static struct scons *scons_mk(pony_type_t *type){ struct scons *scons = pony_alloc(sizeof(struct scons)); scons->eos = false; scons->element = (value_t) {.p = NULL}; + scons->type = type; scons->next = NULL; return scons; } @@ -21,17 +40,18 @@ static void scons_print(struct scons *scons){ printf("struct scons@%p{\n", scons); printf(" eos = %s\n", scons->eos? "true": "false"); printf(" element = %d\n", scons->element.i); + printf(" type = %p\n", scons->type); printf(" next = %p\n", scons->next); printf("}\n"); } stream_t *stream_mk(){ - return future_mk(); + return future_mk(&scons_type); } -stream_t *stream_put(stream_t *s, pony_arg_t value){ - future_t *fut = future_mk(); - struct scons *scons = scons_mk(); +stream_t *stream_put(stream_t *s, pony_arg_t value, pony_type_t *type){ + future_t *fut = future_mk(&scons_type); + struct scons *scons = scons_mk(type); scons->element = value; scons->next = fut; future_fulfil((future_t *)s, scons); @@ -54,7 +74,7 @@ stream_t *stream_get_next(stream_t *s){ } void stream_close(stream_t *s){ - struct scons *scons = scons_mk(); + struct scons *scons = scons_mk(NULL); scons->eos = true; future_fulfil((future_t *)s, scons); } \ No newline at end of file diff --git a/src/runtime/stream/stream.h b/src/runtime/stream/stream.h index 7f1aa6607..e48a67e53 100644 --- a/src/runtime/stream/stream.h +++ b/src/runtime/stream/stream.h @@ -1,7 +1,7 @@ #ifndef __stream_h__ #define __stream_h__ -#include //only for pony_arg_t +#include #include typedef void stream_t; @@ -19,9 +19,10 @@ stream_t *stream_mk(); * * @param s A stream * @param value The value to be put in the stream + * @param type The runtime type of \p value * @return The (empty) head of \p s */ -stream_t *stream_put(stream_t *s, pony_arg_t value); +stream_t *stream_put(stream_t *s, pony_arg_t value, pony_type_t *type); /** * Read a value from a stream From f09585c700ee0ada6fb265e4883b78150f221cd7 Mon Sep 17 00:00:00 2001 From: Elias Castegren Date: Tue, 3 Feb 2015 16:53:15 +0100 Subject: [PATCH 002/172] Proper calls to future_mk generated --- src/back/CodeGen/Expr.hs | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/src/back/CodeGen/Expr.hs b/src/back/CodeGen/Expr.hs index 1ef62436e..c9d581492 100644 --- a/src/back/CodeGen/Expr.hs +++ b/src/back/CodeGen/Expr.hs @@ -235,12 +235,13 @@ instance Translatable A.Expr (State Ctx.Context (CCode Lval, CCode Stat)) where Ctx.gen_named_sym "stream" else Ctx.gen_named_sym "fut" - let the_fut_decl = if Ty.isStreamType $ A.getType call then - Assign (Decl (Ptr $ Typ "stream_t", Var the_fut_name)) - (Call (Nam "stream_mk") ([] :: [CCode Expr])) - else - Assign (Decl (Ptr $ Typ "future_t", Var the_fut_name)) - (Call (Nam "future_mk") ([runtime_type $ A.getType call])) + let the_fut_decl = + if Ty.isStreamType $ A.getType call then + Assign (Decl (Ptr $ Typ "stream_t", Var the_fut_name)) + (Call (Nam "stream_mk") ([] :: [CCode Expr])) + else + Assign (Decl (Ptr $ Typ "future_t", Var the_fut_name)) + (Call (Nam "future_mk") ([runtime_type . Ty.getResultType . A.getType $ call])) the_arg_name <- Ctx.gen_named_sym "arg" let the_arg_decl = Assign (Decl (Typ "pony_arg_t", ArrAcc (1 + length args) (Var the_arg_name))) @@ -417,7 +418,9 @@ instance Translatable A.Expr (State Ctx.Context (CCode Lval, CCode Stat)) where do (nfuture,tfuture) <- translate future (nchain, tchain) <- translate chain fut_name <- Ctx.gen_sym - let fut_decl = Assign (Decl (Ptr $ Typ "future_t", Var fut_name)) (Call (Nam "future_mk") ([] :: [CCode Lval])) + let ty = runtime_type . Ty.getResultType . A.getType $ chain + fut_decl = Assign (Decl (Ptr $ Typ "future_t", Var fut_name)) + (Call (Nam "future_mk") [ty]) result <- Ctx.gen_sym return $ (Var result, Seq [tfuture, tchain, From e94f0890a3b7de55be8f4fdc927c11fc7b5e88ea Mon Sep 17 00:00:00 2001 From: Elias Castegren Date: Tue, 3 Feb 2015 16:53:48 +0100 Subject: [PATCH 003/172] Fixed bug where future_trace got stuck --- src/runtime/future/future.c | 1 + 1 file changed, 1 insertion(+) diff --git a/src/runtime/future/future.c b/src/runtime/future/future.c index 84f948994..6e831da12 100644 --- a/src/runtime/future/future.c +++ b/src/runtime/future/future.c @@ -109,6 +109,7 @@ void future_trace(void *p) closure_entry_t *cursor = fut->children; while(cursor != NULL){ pony_traceobject(cursor->future, future_trace); + cursor = cursor->next; } } From 38a999bf53f980f223565761fc9a1cd8552c6f68 Mon Sep 17 00:00:00 2001 From: Elias Castegren Date: Wed, 4 Feb 2015 07:17:49 +0100 Subject: [PATCH 004/172] Fixed naming in set library --- src/runtime/set/set.c | 6 +++--- src/runtime/set/set.h | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/runtime/set/set.c b/src/runtime/set/set.c index 7e5287c0c..03c3df519 100644 --- a/src/runtime/set/set.c +++ b/src/runtime/set/set.c @@ -34,7 +34,7 @@ struct set{ struct node *root; }; -set_t *mk_set(void){ +set_t *set_mk(void){ set_t *set = ALLOC(sizeof(set_t)); if(set) set->root = NULL; @@ -155,7 +155,7 @@ set_t *set_clone(set_t *set){ set_t *newSet = NULL; if(set) - newSet = mk_set(); + newSet = set_mk(); if(newSet) cloneNode(set->root, &(newSet->root)); return newSet; @@ -202,7 +202,7 @@ static set_t *node_map(struct node *node, set_t *result, map_fnc f){ set_t *set_map(set_t *set, map_fnc f){ if(set) - return node_map(set->root, mk_set(), f); + return node_map(set->root, set_mk(), f); else return NULL; } diff --git a/src/runtime/set/set.h b/src/runtime/set/set.h index 626d1af9f..7bbf247ab 100644 --- a/src/runtime/set/set.h +++ b/src/runtime/set/set.h @@ -21,7 +21,7 @@ typedef void *(*reduce_fnc)(void *elem, void *accumulator); * Create a new empty set. Use set_destroy"()" to free the allocated memory. * @return A new empty set */ -set_t *mk_set(void); +set_t *set_mk(void); /** * Insert an element in a set. From 256019a9688aff53826a7d2ba29d7976eb7fc697 Mon Sep 17 00:00:00 2001 From: Elias Castegren Date: Wed, 4 Feb 2015 07:18:26 +0100 Subject: [PATCH 005/172] Removed comments --- src/runtime/future/future.c | 1 - src/runtime/stream/stream.c | 1 - 2 files changed, 2 deletions(-) diff --git a/src/runtime/future/future.c b/src/runtime/future/future.c index 6e831da12..b53cf8e2d 100644 --- a/src/runtime/future/future.c +++ b/src/runtime/future/future.c @@ -95,7 +95,6 @@ void future_trace(void *p) future_t *fut = (future_t *) p; if(future_fulfilled(fut)){ // Should the tracer need to block on the future? if(fut->type == PONY_NONE){ -// pony_trace(p); }else if (fut->type == PONY_ACTOR){ pony_traceactor(fut->value); }else{ diff --git a/src/runtime/stream/stream.c b/src/runtime/stream/stream.c index 65daaa584..16167285e 100644 --- a/src/runtime/stream/stream.c +++ b/src/runtime/stream/stream.c @@ -14,7 +14,6 @@ void scons_trace(void *p){ if(!scons->eos){ pony_type_t *type = scons->type; if(type == PONY_NONE){ -// pony_trace(scons->element.p); } else if (type == PONY_ACTOR){ pony_traceactor(scons->element.p); } else{ From 770b9977c1185029fc2db578ab9e7820fa1f9e72 Mon Sep 17 00:00:00 2001 From: Elias Castegren Date: Wed, 4 Feb 2015 08:06:49 +0100 Subject: [PATCH 006/172] Fixed naming in closure lib --- src/back/CodeGen/Expr.hs | 2 +- src/back/CodeGen/Shared.hs | 2 +- src/runtime/closure/closure.c | 2 +- src/runtime/closure/closure.h | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/back/CodeGen/Expr.hs b/src/back/CodeGen/Expr.hs index c9d581492..b77d95ed6 100644 --- a/src/back/CodeGen/Expr.hs +++ b/src/back/CodeGen/Expr.hs @@ -435,7 +435,7 @@ instance Translatable A.Expr (State Ctx.Context (CCode Lval, CCode Stat)) where fill_env <- mapM (insert_var env_name) free_vars return $ (Var tmp, Seq $ (mk_env env_name) : fill_env ++ [Assign (Decl (closure, Var tmp)) - (Call (Nam "mk_closure") [fun_name, env_name])]) + (Call (Nam "closure_mk") [fun_name, env_name])]) where mk_env name = Assign (Decl (Ptr $ Struct name, AsLval name)) diff --git a/src/back/CodeGen/Shared.hs b/src/back/CodeGen/Shared.hs index 6d48950fe..fdd8fc348 100644 --- a/src/back/CodeGen/Shared.hs +++ b/src/back/CodeGen/Shared.hs @@ -71,7 +71,7 @@ generate_shared A.Program{A.etl = A.EmbedTL{A.etlbody}, A.functions} = where init_global A.Function{A.funname} = Assign (global_closure_name funname) - (Call (Nam "mk_closure") [AsExpr $ AsLval $ global_function_name funname, Null]) + (Call (Nam "closure_mk") [AsExpr $ AsLval $ global_function_name funname, Null]) comment_section :: String -> CCode Toplevel comment_section s = Embed $ (take (5 + length s) $ repeat '/') ++ "\n// " ++ s diff --git a/src/runtime/closure/closure.c b/src/runtime/closure/closure.c index 4981de681..8ff3ae18c 100644 --- a/src/runtime/closure/closure.c +++ b/src/runtime/closure/closure.c @@ -24,7 +24,7 @@ struct closure{ void *env; }; -closure_t *mk_closure(closure_fun fn, void *env){ +closure_t *closure_mk(closure_fun fn, void *env){ closure_t *c = ALLOC(sizeof(closure_t)); c->call = fn; c->env = env; diff --git a/src/runtime/closure/closure.h b/src/runtime/closure/closure.h index d96bf0835..784bed9d7 100644 --- a/src/runtime/closure/closure.h +++ b/src/runtime/closure/closure.h @@ -33,7 +33,7 @@ typedef value_t (*closure_fun)(value_t[], void*); * @param env The environment of the closure * @return A closure with body \p body and environment \p env */ -closure_t *mk_closure(closure_fun body, void *env); +closure_t *closure_mk(closure_fun body, void *env); /** * Call a closure. From 4779cd4eca360bc006ee527be3fed4b9b94e4d1f Mon Sep 17 00:00:00 2001 From: Elias Castegren Date: Wed, 4 Feb 2015 09:19:10 +0100 Subject: [PATCH 007/172] Tracing of closures --- src/back/CodeGen/CCodeNames.hs | 9 ++++++++- src/back/CodeGen/Closure.hs | 18 +++++++++++++++++- src/back/CodeGen/Expr.hs | 10 ++++++---- src/back/CodeGen/Shared.hs | 5 ++++- src/back/CodeGen/Type.hs | 1 + src/runtime/closure/closure.c | 20 +++++++++++++------- src/runtime/closure/closure.h | 9 ++++++--- src/runtime/future/future.c | 12 ++++++------ 8 files changed, 61 insertions(+), 23 deletions(-) diff --git a/src/back/CodeGen/CCodeNames.hs b/src/back/CodeGen/CCodeNames.hs index cf9c59d96..b291a48a2 100644 --- a/src/back/CodeGen/CCodeNames.hs +++ b/src/back/CodeGen/CCodeNames.hs @@ -56,6 +56,10 @@ closure_env_name :: String -> CCode Name closure_env_name name = Nam $ "_" ++ name ++ "_env" +closure_trace_name :: String -> CCode Name +closure_trace_name name = + Nam $ "_" ++ name ++ "_trace" + stream_handle :: CCode Lval stream_handle = Var "_stream" @@ -101,4 +105,7 @@ type_rec_name :: Ty.Type -> CCode Name type_rec_name clazz = Nam $ Ty.getId clazz ++ "_type" future_type_rec_name :: CCode Name -future_type_rec_name = Nam $ "future_type" \ No newline at end of file +future_type_rec_name = Nam $ "future_type" + +closure_type_rec_name :: CCode Name +closure_type_rec_name = Nam $ "closure_type" \ No newline at end of file diff --git a/src/back/CodeGen/Closure.hs b/src/back/CodeGen/Closure.hs index de657d053..da9e2c7c0 100644 --- a/src/back/CodeGen/Closure.hs +++ b/src/back/CodeGen/Closure.hs @@ -31,10 +31,12 @@ translateClosure closure id = Meta.getMetaId . A.getMeta $ closure fun_name = closure_fun_name id env_name = closure_env_name id + trace_name = closure_trace_name id freeVars = Util.freeVariables (map A.pname params) body ((bodyName, bodyStat), _) = runState (translate body) Ctx.empty in Concat [buildEnvironment env_name freeVars, + tracefun_decl trace_name env_name freeVars, Function (Typ "value_t") fun_name [(Typ "value_t", Var "_args[]"), (Ptr void, Var "_env")] (Seq $ @@ -75,4 +77,18 @@ translateClosure closure (Assign (Decl (translate ty, Var $ show name)) (getVar name)) : extractEnvironment envName vars where getVar name = - (Deref $ Cast (Ptr $ Struct envName) (Var "_env")) `Dot` (Nam $ show name) \ No newline at end of file + (Deref $ Cast (Ptr $ Struct envName) (Var "_env")) `Dot` (Nam $ show name) + + tracefun_decl traceName envName members = + Function void traceName [(Ptr void, Var "p")] + (Seq $ map traceMember members) + where + traceMember (name, ty) + | Ty.isActiveRefType ty = + Call (Nam "pony_traceactor") [getVar name] + | Ty.isPassiveRefType ty = + Call (Nam "pony_traceobject") + [getVar name, AsLval $ class_trace_fn_name ty] + | otherwise = Comm $ "Not tracing member '" ++ show name ++ "'" + getVar name = + (Deref $ Cast (Ptr $ Struct envName) (Var "p")) `Dot` (Nam $ show name) diff --git a/src/back/CodeGen/Expr.hs b/src/back/CodeGen/Expr.hs index b77d95ed6..01c0a7679 100644 --- a/src/back/CodeGen/Expr.hs +++ b/src/back/CodeGen/Expr.hs @@ -428,14 +428,16 @@ instance Translatable A.Expr (State Ctx.Context (CCode Lval, CCode Stat)) where (Assign (Decl (Ptr $ Typ "future_t", Var result)) (Call (Nam "future_chain_actor") [nfuture, (Var fut_name), nchain]))]) translate clos@(A.Closure{A.eparams, A.body}) = - do let fun_name = closure_fun_name . Meta.getMetaId . A.getMeta $ clos - env_name = closure_env_name . Meta.getMetaId . A.getMeta $ clos - free_vars = Util.freeVariables (map A.pname eparams) body + do let meta_id = Meta.getMetaId . A.getMeta $ clos + fun_name = closure_fun_name meta_id + env_name = closure_env_name meta_id + trace_name = closure_trace_name meta_id + free_vars = Util.freeVariables (map A.pname eparams) body tmp <- Ctx.gen_sym fill_env <- mapM (insert_var env_name) free_vars return $ (Var tmp, Seq $ (mk_env env_name) : fill_env ++ [Assign (Decl (closure, Var tmp)) - (Call (Nam "closure_mk") [fun_name, env_name])]) + (Call (Nam "closure_mk") [fun_name, env_name, trace_name])]) where mk_env name = Assign (Decl (Ptr $ Struct name, AsLval name)) diff --git a/src/back/CodeGen/Shared.hs b/src/back/CodeGen/Shared.hs index fdd8fc348..cb3a18383 100644 --- a/src/back/CodeGen/Shared.hs +++ b/src/back/CodeGen/Shared.hs @@ -71,7 +71,10 @@ generate_shared A.Program{A.etl = A.EmbedTL{A.etlbody}, A.functions} = where init_global A.Function{A.funname} = Assign (global_closure_name funname) - (Call (Nam "closure_mk") [AsExpr $ AsLval $ global_function_name funname, Null]) + (Call (Nam "closure_mk") + [AsExpr $ AsLval $ global_function_name funname, + Null, + Null]) comment_section :: String -> CCode Toplevel comment_section s = Embed $ (take (5 + length s) $ repeat '/') ++ "\n// " ++ s diff --git a/src/back/CodeGen/Type.hs b/src/back/CodeGen/Type.hs index 37bb0f700..bebcffee2 100644 --- a/src/back/CodeGen/Type.hs +++ b/src/back/CodeGen/Type.hs @@ -43,4 +43,5 @@ runtime_type ty | Ty.isPassiveRefType ty = Amp $ type_rec_name ty | Ty.isFutureType ty || Ty.isStreamType ty = Amp $ future_type_rec_name + | Ty.isArrowType ty = Amp $ closure_type_rec_name | otherwise = AsExpr $ Var "PONY_NONE" \ No newline at end of file diff --git a/src/runtime/closure/closure.c b/src/runtime/closure/closure.c index 8ff3ae18c..3f01e4023 100644 --- a/src/runtime/closure/closure.c +++ b/src/runtime/closure/closure.c @@ -22,12 +22,23 @@ extern __thread pony_actor_t* this_actor; struct closure{ closure_fun call; void *env; + pony_trace_fn trace; }; -closure_t *closure_mk(closure_fun fn, void *env){ +pony_type_t closure_type = {sizeof(struct closure), closure_trace, NULL, NULL}; + +void closure_trace(void *p){ + closure_t *c = (closure_t *) p; + if(c->trace != NULL){ + c->trace(c->env); + } +} + +closure_t *closure_mk(closure_fun fn, void *env, pony_trace_fn trace){ closure_t *c = ALLOC(sizeof(closure_t)); c->call = fn; c->env = env; + c->trace = trace; return c; } @@ -62,9 +73,4 @@ int val_to_int(value_t v){ double val_to_dbl(value_t v){ return v.d; -} - -void closure_trace(closure_t* c) { - pony_trace(c); - pony_trace(c->env); -} +} \ No newline at end of file diff --git a/src/runtime/closure/closure.h b/src/runtime/closure/closure.h index 784bed9d7..4c673a4da 100644 --- a/src/runtime/closure/closure.h +++ b/src/runtime/closure/closure.h @@ -15,6 +15,10 @@ typedef union value { typedef struct closure closure_t; +extern pony_type_t closure_type; + +void closure_trace(void *p); + /** * The body of a closure. @@ -31,9 +35,10 @@ typedef value_t (*closure_fun)(value_t[], void*); * * @param body The body of the closure (see the typedef of closure_fun) * @param env The environment of the closure + * @param trace The trace function of the environment * @return A closure with body \p body and environment \p env */ -closure_t *closure_mk(closure_fun body, void *env); +closure_t *closure_mk(closure_fun body, void *env, pony_trace_fn trace); /** * Call a closure. @@ -49,6 +54,4 @@ value_t closure_call(closure_t *closure, value_t args[]); */ void closure_free(closure_t *closure); -void closure_trace(closure_t *c); - #endif diff --git a/src/runtime/future/future.c b/src/runtime/future/future.c index b53cf8e2d..28c2fa639 100644 --- a/src/runtime/future/future.c +++ b/src/runtime/future/future.c @@ -94,20 +94,20 @@ void future_trace(void *p) { future_t *fut = (future_t *) p; if(future_fulfilled(fut)){ // Should the tracer need to block on the future? - if(fut->type == PONY_NONE){ - }else if (fut->type == PONY_ACTOR){ + if (fut->type == PONY_ACTOR){ pony_traceactor(fut->value); - }else{ + }else if(fut->type != PONY_NONE){ pony_traceobject(fut->value, fut->type->trace); } } // TODO: Who traces whom? - for(int i = 0; i < fut->no_responsibilities; i++){ - pony_traceactor(fut->responsibilities[i].message.actor); - } + // for(int i = 0; i < fut->no_responsibilities; i++){ + // pony_traceactor(fut->responsibilities[i].message.actor); + // } closure_entry_t *cursor = fut->children; while(cursor != NULL){ pony_traceobject(cursor->future, future_trace); + closure_trace(cursor->closure); cursor = cursor->next; } } From c822ce0b7c517c7f952a054a740ffbcc6e8aaeb2 Mon Sep 17 00:00:00 2001 From: Elias Castegren Date: Wed, 4 Feb 2015 10:22:05 +0100 Subject: [PATCH 008/172] GC does not need to block on futures --- src/runtime/future/future.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/runtime/future/future.c b/src/runtime/future/future.c index 28c2fa639..cae1fd4df 100644 --- a/src/runtime/future/future.c +++ b/src/runtime/future/future.c @@ -93,8 +93,8 @@ pony_type_t *future_get_type(future_t *fut){ void future_trace(void *p) { future_t *fut = (future_t *) p; - if(future_fulfilled(fut)){ // Should the tracer need to block on the future? - if (fut->type == PONY_ACTOR){ + if(fut->fulfilled){ + if(fut->type == PONY_ACTOR){ pony_traceactor(fut->value); }else if(fut->type != PONY_NONE){ pony_traceobject(fut->value, fut->type->trace); From 6e8c8dea186659d34a6cf46b88390866e7f00ac0 Mon Sep 17 00:00:00 2001 From: Albert Netymk Date: Wed, 4 Feb 2015 11:33:46 +0100 Subject: [PATCH 009/172] Replace old PonyRT with new PonyRT. --- src/runtime/encore/README.md | 1 + src/runtime/pony/.gitignore | 9 + src/runtime/pony/Doxyfile | 2331 +++++++++++++++++ .../pony/examples/RandomAccess/arrays.c | 16 +- .../pony/examples/RandomAccess/arrays.h | 1 - src/runtime/pony/examples/RandomAccess/main.c | 147 +- src/runtime/pony/examples/RandomAccess/main.h | 1 - .../pony/examples/RandomAccess/streamer.c | 135 +- .../pony/examples/RandomAccess/updater.c | 126 +- .../pony/examples/RandomAccess2/arrays.c | 28 +- .../pony/examples/RandomAccess2/arrays.h | 2 - .../pony/examples/RandomAccess2/main.c | 114 +- .../pony/examples/RandomAccess2/updater.c | 181 +- src/runtime/pony/examples/counter.c | 79 +- src/runtime/pony/examples/dist.c | 80 + src/runtime/pony/examples/fut/eager.c | 234 -- src/runtime/pony/examples/fut/lazy.c | 221 -- src/runtime/pony/examples/fut/shared.c | 258 -- src/runtime/pony/examples/mailbox.c | 92 +- src/runtime/pony/examples/mixed.c | 140 +- src/runtime/pony/examples/premake4.lua | 65 +- src/runtime/pony/examples/ring.c | 94 +- src/runtime/pony/examples/service.c | 48 +- src/runtime/pony/examples/spreader.c | 108 +- src/runtime/pony/inc/platform/alloc.h | 20 + src/runtime/pony/inc/platform/atomics.h | 142 + src/runtime/pony/inc/platform/io.h | 18 + src/runtime/pony/inc/platform/platform.h | 170 ++ src/runtime/pony/inc/platform/threads.h | 38 + src/runtime/pony/inc/platform/utils.h | 16 + src/runtime/pony/inc/pony/pony.h | 287 +- src/runtime/pony/premake4.lua | 133 +- src/runtime/pony/premake5.lua | 264 ++ src/runtime/pony/scripts/docs.lua | 2 + src/runtime/pony/scripts/properties.lua | 28 + src/runtime/pony/scripts/release.lua | 2 + src/runtime/pony/scripts/tests.lua | 4 + src/runtime/pony/src/actor/actor.c | 400 +-- src/runtime/pony/src/actor/actor.h | 27 +- src/runtime/pony/src/actor/messageq.c | 62 +- src/runtime/pony/src/actor/messageq.h | 17 +- src/runtime/pony/src/asio/asio.c | 80 +- src/runtime/pony/src/asio/asio.h | 74 +- src/runtime/pony/src/asio/epoll.c | 104 +- src/runtime/pony/src/asio/event.c | 15 +- src/runtime/pony/src/asio/event.h | 57 +- src/runtime/pony/src/asio/iocp.c | 7 + src/runtime/pony/src/asio/kqueue.c | 104 +- src/runtime/pony/src/asio/sock.c | 552 ++-- src/runtime/pony/src/asio/sock.h | 119 +- src/runtime/pony/src/asio/streambuf.c | 225 -- src/runtime/pony/src/asio/streambuf.h | 69 - src/runtime/pony/src/dist/dist.c | 380 +-- src/runtime/pony/src/dist/dist.h | 35 +- src/runtime/pony/src/dist/proto.c | 159 +- src/runtime/pony/src/dist/proto.h | 42 +- src/runtime/pony/src/ds/fun.c | 8 +- src/runtime/pony/src/ds/hash.c | 6 +- src/runtime/pony/src/ds/hash.h | 12 +- src/runtime/pony/src/ds/list.c | 10 +- src/runtime/pony/src/ds/list.h | 15 +- src/runtime/pony/src/ds/stack.c | 2 +- src/runtime/pony/src/gc/actormap.c | 2 +- src/runtime/pony/src/gc/cycle.c | 84 +- src/runtime/pony/src/gc/delta.c | 4 +- src/runtime/pony/src/gc/gc.c | 8 +- src/runtime/pony/src/gc/objectmap.c | 2 +- src/runtime/pony/src/gc/trace.c | 25 +- src/runtime/pony/src/gc/trace.h | 12 +- src/runtime/pony/src/lang/lsda.c | 232 ++ src/runtime/pony/src/lang/lsda.h | 43 + src/runtime/pony/src/lang/posix_except.c | 63 + src/runtime/pony/src/lang/win_except.c | 112 + src/runtime/pony/src/mem/heap.c | 77 +- src/runtime/pony/src/mem/heap.h | 17 +- src/runtime/pony/src/mem/pagemap.c | 26 +- src/runtime/pony/src/mem/pool.c | 105 +- src/runtime/pony/src/mem/pool.h | 71 +- src/runtime/pony/src/platform/alloc.c | 37 + src/runtime/pony/src/platform/threads.c | 46 + src/runtime/pony/src/platform/utils.c | 29 + src/runtime/pony/src/premake4.lua | 38 +- src/runtime/pony/src/premake5.lua | 18 + src/runtime/pony/src/sched/cpu.c | 94 +- src/runtime/pony/src/sched/mpmcq.c | 18 +- src/runtime/pony/src/sched/mpmcq.h | 35 +- src/runtime/pony/src/sched/scheduler.c | 207 +- src/runtime/pony/src/sched/scheduler.h | 4 +- src/runtime/pony/src/sched/start.c | 44 +- src/runtime/pony/test/ds/fun.cc | 3 +- src/runtime/pony/test/ds/hash.cc | 4 +- src/runtime/pony/test/ds/list.cc | 1 + src/runtime/pony/test/main.cc | 6 + src/runtime/pony/test/premake4.lua | 13 +- src/runtime/pony/utils/premake4.lua | 6 +- 95 files changed, 6254 insertions(+), 3448 deletions(-) create mode 100644 src/runtime/encore/README.md create mode 100644 src/runtime/pony/Doxyfile create mode 100644 src/runtime/pony/examples/dist.c delete mode 100644 src/runtime/pony/examples/fut/eager.c delete mode 100644 src/runtime/pony/examples/fut/lazy.c delete mode 100644 src/runtime/pony/examples/fut/shared.c create mode 100644 src/runtime/pony/inc/platform/alloc.h create mode 100644 src/runtime/pony/inc/platform/atomics.h create mode 100644 src/runtime/pony/inc/platform/io.h create mode 100644 src/runtime/pony/inc/platform/platform.h create mode 100644 src/runtime/pony/inc/platform/threads.h create mode 100644 src/runtime/pony/inc/platform/utils.h create mode 100644 src/runtime/pony/premake5.lua create mode 100644 src/runtime/pony/scripts/docs.lua create mode 100644 src/runtime/pony/scripts/properties.lua create mode 100644 src/runtime/pony/scripts/release.lua create mode 100644 src/runtime/pony/scripts/tests.lua create mode 100644 src/runtime/pony/src/asio/iocp.c delete mode 100644 src/runtime/pony/src/asio/streambuf.c delete mode 100644 src/runtime/pony/src/asio/streambuf.h create mode 100644 src/runtime/pony/src/lang/lsda.c create mode 100644 src/runtime/pony/src/lang/lsda.h create mode 100644 src/runtime/pony/src/lang/posix_except.c create mode 100644 src/runtime/pony/src/lang/win_except.c create mode 100644 src/runtime/pony/src/platform/alloc.c create mode 100644 src/runtime/pony/src/platform/threads.c create mode 100644 src/runtime/pony/src/platform/utils.c create mode 100644 src/runtime/pony/src/premake5.lua create mode 100644 src/runtime/pony/test/main.cc diff --git a/src/runtime/encore/README.md b/src/runtime/encore/README.md new file mode 100644 index 000000000..36894d6c2 --- /dev/null +++ b/src/runtime/encore/README.md @@ -0,0 +1 @@ +== Extension to ponyrt from UU side. diff --git a/src/runtime/pony/.gitignore b/src/runtime/pony/.gitignore index bd1734c22..a19d1f146 100644 --- a/src/runtime/pony/.gitignore +++ b/src/runtime/pony/.gitignore @@ -2,6 +2,15 @@ Makefile *.make +Build + +# Visual Studio files +*.vcxproj* +*.sln +*.suo +*.opensdf +*.sdf + # Binaries bin diff --git a/src/runtime/pony/Doxyfile b/src/runtime/pony/Doxyfile new file mode 100644 index 000000000..fe13cdd69 --- /dev/null +++ b/src/runtime/pony/Doxyfile @@ -0,0 +1,2331 @@ +# Doxyfile 1.8.8 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single 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. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "My Project" + +# 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 = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. 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 causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = 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. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES 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. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES 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. +# The default value is: YES. + +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 and the. + +ABBREVIATE_BRIEF = + +# 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. +# The default value is: NO. + +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. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES 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 +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# 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. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# 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 list of 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. +# The default value is: NO. + +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-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +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 Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +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 behavior. 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 behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +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. +# The default value is: NO. + +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. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act 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 = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# 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. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +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. +# The default value is: NO. + +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 (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. 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 For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# 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); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) 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. +# The default value is: NO. + +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 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. +# The default value is: YES. + +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. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES 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. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag 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. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_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 respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = YES + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +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. Does not have any effect +# for Java sources. +# The default value is: YES. + +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 only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# 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. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO 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. +# The default value is: NO. + +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 these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +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 these declarations will be +# included in the documentation. +# The default value is: NO. + +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 these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +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 then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +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. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# 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. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES 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. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +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 constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: 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 group names will +# appear in their defined order. +# The default value is: NO. + +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 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. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = 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. +# The default value is: YES. + +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. +# The default value is: YES. + +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. +# The default value is: YES. + +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. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have 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 value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +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. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# 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 value 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 value 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 command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +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. To 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. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag 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. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag 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. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +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) +# The default value is: $file:$line: $text. + +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 standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is 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. +# Note: If this tag is empty the current directory is searched. + +INPUT = ./examples/counter.c ./examples/mailbox.c ./examples/mixed.c ./examples/RandomAccess/arrays.c ./examples/RandomAccess/main.c ./examples/RandomAccess/streamer.c ./examples/RandomAccess/updater.c ./examples/RandomAccess2/arrays.c ./examples/RandomAccess2/main.c ./examples/RandomAccess2/updater.c ./examples/ring.c ./examples/service.c ./examples/spreader.c ./src/actor/actor.c ./src/actor/messageq.c ./src/asio/asio.c ./src/asio/epoll.c ./src/asio/event.c ./src/asio/kqueue.c ./src/asio/sock.c ./src/asio/streambuf.c ./src/dist/dist.c ./src/dist/proto.c ./src/ds/fun.c ./src/ds/hash.c ./src/ds/list.c ./src/ds/stack.c ./src/gc/actormap.c ./src/gc/cycle.c ./src/gc/delta.c ./src/gc/gc.c ./src/gc/objectmap.c ./src/gc/trace.c ./src/mem/heap.c ./src/mem/pagemap.c ./src/mem/pool.c ./src/sched/cpu.c ./src/sched/mpmcq.c ./src/sched/scheduler.c ./src/sched/start.c + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +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 patterns (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, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.c *.h + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# 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. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +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 = + +# 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 +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */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. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be 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. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +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 information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# 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 that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# 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. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES 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. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = 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. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES 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. +# See also: Section \class. +# The default value is: YES. + +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. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +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 a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +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. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +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). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +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 left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra stylesheet files is of importance (e.g. the last +# stylesheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# 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. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = 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. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# 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 (see: http://developer.apple.com/tools/xcode/), 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. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset 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. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# 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. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# 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. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# 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. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# 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). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# 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. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +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. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +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. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +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 Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +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 (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# 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. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they 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. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +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. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# 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. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# 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. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. 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. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# 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. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /