rename some traces as print. Update dox

Author: mulle-nat

bin/release.sh

@@ -1,45 +1,142 @@
-#! /bin/sh
+#! /usr/bin/env bash
+#
+#   Copyright (c) 2017 Nat! - Mulle kybernetiK
+#   All rights reserved.
+#
+#   Redistribution and use in source and binary forms, with or without
+#   modification, are permitted provided that the following conditions are met:
+#
+#   Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+#   Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+#   Neither the name of Mulle kybernetiK nor the names of its contributors
+#   may be used to endorse or promote products derived from this software
+#   without specific prior written permission.
+#
+#   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+#   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+#   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+#   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+#   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+#   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+#   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+#   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+#   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+#   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+#   POSSIBILITY OF SUCH DAMAGE.
+#
+
+
+# Define your project and the dependencies for homebrew
+# DEPENDENCIES and BUILD_DEPENDENCIES will be evaled later!
+# Then run this as
+#   ./bin/release.sh --publisher mulle-nat --publisher-tap mulle-kybernetik/alpha/
+#
 
 PROJECT="MulleObjcRuntime"    # requires camel-case
 DESC="An Objective-C runtime, written 100% in C"
-DEPENDENCIES='${DEPENDENCY_TAP}mulle-concurrent
-${DEPENDENCY_TAP}mulle-vararg'  # no camel case, will be evaled later!
 LANGUAGE=c                    # c,cpp, objc
 
-HEADER="src/mulle_objc_version.h"
-VERSIONNAME="MULLE_OBJC_RUNTIME_VERSION"
 NAME="mulle-objc-runtime"
 
+
+#
+# Keep these commented out, if the automatic detection works well
+# enough for you
+#
+VERSIONFILE="src/mulle_objc_version.h"
+VERSIONNAME="MULLE_OBJC_RUNTIME_VERSION"
+
+#
+# Specify needed homebrew packages by name as you would when saying
+# `brew install`.
+#
+# Use the ${DEPENDENCY_TAP} prefix for non-official dependencies.
+#
+DEPENDENCIES='${DEPENDENCY_TAP}mulle-concurrent
+${DEPENDENCY_TAP}mulle-vararg'
+
+BUILD_DEPENDENCIES='${BOOTSTRAP_TAP}mulle-bootstrap
+${BOOTSTRAP_TAP}mulle-build
+cmake'  # cmake would be useful to, if you are cmake based!
+
+
+#######
+# If you are using mulle-build, you don't hafta change anything after this
+#######
+
+#
+# Generate your `def install` `test do` lines here to stdout.
+#
+generate_brew_formula_build()
+{
+   local project="$1"
+   local name="$2"
+   local version="$3"
+
+   generate_brew_formula_mulle_build "${project}" "${name}" "${version}"
+   generate_brew_formula_mulle_test  "${project}" "${name}" "${version}"
+}
+
+
 #
-# Ideally you don't hafta change anything below this line
+# If you are unhappy with the formula in general, then change
+# this function. Print your formula to stdout.
 #
-# source mulle-homebrew.sh (clumsily)
+generate_brew_formula()
+{
+#   local project="$1"
+#   local name="$2"
+#   local version="$3"
+#   local dependencies="$4"
+#   local builddependencies="$5"
+#   local homepage="$6"
+#   local desc="$7"
+#   local archiveurl="$8"
+
+   _generate_brew_formula "$@"
+}
 
-PUBLISHER="mulle-nat"
-PUBLISHER_TAP="mulle-kybernetik/software/"
-DEPENDENCY_TAP="mulle-kybernetik/software/"
-BOOTSTRAP_TAP="mulle-kybernetik/alpha/"
+#######
+# Ideally changes to the following values are done with the command line
+# which makes it easier for forks.
+#######
 
+MULLE_BOOTSTRAP_FAIL_PREFIX="`basename -- $0`"
+MULLE_HOMEBREW_VERSION="3.4.3"
 
-MULLE_BOOTSTRAP_FAIL_PREFIX="release.sh"
-DIR="`dirname -- "$0"`"
-. ${DIR}/mulle-homebrew/mulle-homebrew.sh || exit 1
-cd "${DIR}/.."
+INSTALLED_MULLE_HOMEBREW_VERSION="`mulle-homebrew-env version`" || exit 1
+LIBEXEC_DIR="`mulle-homebrew-env libexec-path`" || exit 1
+
+. "${LIBEXEC_DIR}/mulle-homebrew.sh" || exit 1
+. "${LIBEXEC_DIR}/mulle-git.sh"      || exit 1
+
+if ! homebrew_is_compatible_version "${INSTALLED_MULLE_HOMEBREW_VERSION}" "${MULLE_HOMEBREW_VERSION}"
+then
+   fail "Installed mulle-homebrew version ${INSTALLED_MULLE_HOMEBREW_VERSION} is \
+not compatible with this script from version ${MULLE_HOMEBREW_VERSION}"
+fi
 
 # parse options
 homebrew_parse_options "$@"
 
-# dial past options
+#
+# dial past options now as they have been parsed
+#
 while [ $# -ne 0 ]
 do
    case "$1" in
       -*)
-         shift # assume treated by homebrew options
+         shift
       ;;
 
       --*)
-         shift # assume treated by homebrew options
-         shift # assume treated by homebrew options
+         shift
+         shift
       ;;
 
       *)
@@ -48,30 +145,103 @@ do
    esac
 done
 
+# --- FORMULA GENERATION ---
 
+BOOTSTRAP_TAP="${BOOTSTRAP_TAP:-mulle-kybernetik/software/}"
+
+DEPENDENCY_TAP="${DEPENDENCY_TAP:-${PUBLISHER_TAP}}"
 
 #
-# this can usually be deduced, if you follow the conventions
+# these can usually be deduced, if you follow the conventions
 #
-VERSION="`get_header_version "${HEADER}" "${VERSIONNAME}"`"
+if [ -z "${NAME}" ]
+then
+   NAME="`get_name_from_project "${PROJECT}" "${LANGUAGE}"`"
+fi
+
+if [ -z "${VERSIONFILE}" ]
+then
+   VERSIONFILE="`get_header_from_name "${NAME}"`"
+fi
+
+if [ -z "${VERSIONNAME}" ]
+then
+   VERSIONNAME="`get_versionname_from_project "${PROJECT}"`"
+fi
+
+if [ -f VERSION ]
+then
+   VERSION="`head -1 VERSION`"
+else
+   VERSION="`get_project_version "${VERSIONFILE}" "${VERSIONNAME}"`"
+   if [ -z "${VERSION}" ]
+   then
+      VERSION="`get_project_version "src/version.h" "${VERSIONNAME}"`"
+   fi
+fi
+
+# where homebrew grabs the archive off
+ARCHIVE_URL="${ARCHIVE_URL:-https://github.com/${PUBLISHER}/${NAME}/archive/${VERSION}.tar.gz}"
+
+# written into formula for homebrew, will be evaled
+HOMEPAGE_URL="${HOMEPAGE_URL:-https://github.com/${PUBLISHER}/${NAME}}"
+
+
+# --- HOMEBREW TAP ---
+# Specify to where and under what name to publish via your brew tap
+#
+if [ -z "${PUBLISHER_TAP}" ]
+then
+   fail "you need to specify a publisher tap with --publisher-tap (hint: <mulle-kybernetik/software/>)"
+fi
+
+TAPS_LOCATION="${TAPS_LOCATION:-..}"
+
+HOMEBREW_TAP="${HOMEBREW_TAP:-${TAPS_LOCATION}/homebrew-`basename -- ${PUBLISHER_TAP}`}"
+
+RBFILE="${RBFILE:-${NAME}.rb}"
 
 # --- GIT ---
+
+#
+# require PUBLISHER (and PUBLISHER_TAP) as command line parameter, so
+# that forks don't have to edit this constantly
+#
+if [ -z "${PUBLISHER}" ]
+then
+   fail "you need to specify a publisher with --publisher (hint: https://github.com/<publisher>)"
+fi
+
+
 # tag to tag your release
-# and the origin where
-TAG="${TAG:-${TAGPREFIX}${VERSION}}"
+TAG="${TAG:-${TAG_PREFIX}${VERSION}}"
 
+# git remote to push to, usually origin
+ORIGIN="${ORIGIN:-origin}"
 
-# --- HOMEBREW TAP ---
-# Specify to where and under what bame to publish via your brew tap
-#
-RBFILE="${NAME}.rb"                  # ruby file for brew
-HOMEBREWTAP="../homebrew-`basename -- ${PUBLISHER_TAP}`"     # your tap repository path
+# git remote to push to, usually github, can be empty
+GITHUB="${GITHUB:-github}"
+
+# git branch to release to, source is always current
+BRANCH="${BRANCH:-release}"
 
 
 main()
 {
-   git_main "${ORIGIN}" "${TAG}" || exit 1
-   homebrew_main
+   # do the release
+   git_main "${BRANCH}" "${ORIGIN}" "${TAG}" "${GITHUB}" || exit 1
+
+   # generate the formula and push it
+   homebrew_main "${PROJECT}" \
+                 "${NAME}" \
+                 "${VERSION}" \
+                 "${DEPENDENCIES}" \
+                 "${BUILD_DEPENDENCIES}" \
+                 "${HOMEPAGE_URL}" \
+                 "${DESC}" \
+                 "${ARCHIVE_URL}" \
+                 "${HOMEBREW_TAP}" \
+                 "${RBFILE}"
 }
 
 main "$@"

dox/API_CLASS.md

@@ -7,14 +7,15 @@ very similiar, it makes sense to read this introduction to classes:
 
 Nevertheless here are some definitions:
 
-class      : A class is one of a classpair
-classpair  : A classpair consists of an infraclass and a metaclass.
-infraclass : Often just synonym with class, this holds the methods for instances (like -dealloc)
-metaclass  : This holds the methods for classes (+alloc)
-superclass : The class a class inherits from (`@interface Foo : Bar  // Bar is the superclass`)
-protocol   : A protocol is a unique id, that tags a classpair. You can ask a class
-             if it conforms to a protocol (has this tag)
-category   : An extension of a classpair, that adds methods to it
+Name         | Definition
+-------------|-------------------------------------------
+class        | A class is one of a classpair
+classpair    | A classpair consists of an infraclass and a metaclass.
+infraclass   | Often just synonym with class, this holds the methods for instances (like -dealloc)
+metaclass    | This holds the methods for classes (like +alloc)
+superclass   | The class a class inherits from (`@interface Foo : Bar  // Bar is the superclass`)
+protocol     | A protocol is a unique id, that tags a classpair. You can ask a class if it conforms to a protocol (has this tag)
+category     | An extension of a classpair, that adds methods to it
 
 
 ## Functions
@@ -33,21 +34,21 @@ int   mulle_objc_class_add_methodlist( struct _mulle_objc_class *cls,
 Add methodlist `list` to `cls`. The methodlist isn't copied, so be sure that is sticks around for the lifetime of the runtime. (Check out `mulle_objc_runtime_unfailing_add_gift`)
 
 
-### `mulle_objc_class_add_protocol`
+### `mulle_objc_classpair_add_protocolid`
 
 ```
-void   mulle_objc_class_add_protocol( struct _mulle_objc_class *cls,
+void   mulle_objc_classpair_add_protocolid( struct _mulle_objc_class *cls,
 mulle_objc_protocolid_t protocolid)
 ```
 
 Add `protocolid` to class `cls`. The protocolid should be added to the infraclass and to the metaclass using two calls to `mulle_objc_class_add_protocol`. The function does not check for duplicates.
 
 
 
-### `mulle_objc_class_is_protocol_class`
+### `mulle_objc_infraclass_is_protocol_class`
 
 ```
-int  mulle_objc_class_is_protocol_class( struct _mulle_objc_class *cls);
+int  mulle_objc_infraclass_is_protocol_class( struct _mulle_objc_infraclass *cls);
 ```
 
 A class is a protocol class if (and only if)
@@ -196,10 +197,10 @@ struct _mulle_objc_class   *mulle_objc_class_get_metaclass( struct _mulle_objc_c
 Given any class of a classpair, returns the metaclass.
 
 
-### `mulle_objc_class_conforms_to_protocol`
+### `mulle_objc_class_conformsto_protocol`
 
 ```
-int   mulle_objc_class_conforms_to_protocol( struct _mulle_objc_class *cls, mulle_objc_protocolid_t protocolid)
+int   mulle_objc_class_conformsto_protocol( struct _mulle_objc_class *cls, mulle_objc_protocolid_t protocolid)
 ```
 
 Returns 1 if `cls` conforms to a protocol with `protocolid`. This can be asked

dox/API_GLOBAL.md

@@ -83,7 +83,7 @@ Compute the **ivarid** from ASCII string `s`. Will return
 mulle_objc_methodid_t   mulle_objc_methodid_from_string( char *s)
 ```
 
-Compute the **methodif** from ASCII string `s`. Will return
+Compute the **methodid** from ASCII string `s`. Will return
 `MULLE_OBJC_NO_METHODID` if `s` is NULL.
 
 
@@ -96,6 +96,7 @@ mulle_objc_protocolid_t   mulle_objc_protocolid_from_string( char *s)
 Compute the **protocolid** from ASCII string `s`. Will return
 `MULLE_OBJC_NO_PROTOCOLID` if `s` is NULL.
 
+
 ## Thread Functions
 
 If your thread wants to acces the mulle-runtime (except the thread you

dox/API_METHOD.md

@@ -26,18 +26,18 @@ Returns the @encoded type of the method. This is an ASCII string, terminated
 by \0. It's lifetime is the same as that of `method`. Don't free it.
 
 
-### `mulle_objc_method_get_id`
+### `mulle_objc_method_get_methodid`
 
 ```
-mulle_objc_methodid_t  mulle_objc_method_get_id( struct _mulle_objc_method *method)
+mulle_objc_methodid_t  mulle_objc_method_get_methodid( struct _mulle_objc_method *method)
 ```
 
 {
-   return( method ? _mulle_objc_method_get_id( method) : MULLE_OBJC_NO_METHODID);
+   return( method ? _mulle_objc_method_get_methodid( method) : MULLE_OBJC_NO_METHODID);
 }
 
 
-Returns the ID od the method. This is a unique hash across all methods.
+Returns the ID of the method. This is a unique hash across all methods.
 
 ### `mulle_objc_method_get_implementation`
 

dox/API_PROPERTY.md

@@ -23,10 +23,10 @@ char   *mulle_objc_property_get_signature( struct _mulle_objc_property *property
 
 Get the signature of the property. This is not the same as the signature of the instance variable. The returned string's lifetime is that of the property. Don't free it.
 
-### `mulle_objc_property_get_id`
+### `mulle_objc_property_get_propertyid`
 
 ```
-mulle_objc_propertyid_t  mulle_objc_property_get_id( struct _mulle_objc_property *property)
+mulle_objc_propertyid_t  mulle_objc_property_get_propertyid( struct _mulle_objc_property *property)
 ```
 
 Get the **propertyid** of the property.