slidefield 0.1

data/README.md

@@ -0,0 +1,254 @@
+# SlideField
+
+**A presentation software that reads plain text files written in its own
+    interpreted language.**
+
+## Installation
+
+Requirements: ruby, sdl, sdl_ttf, freeimage
+
+    $ gem install slidefield
+
+
+## Usage
+
+    $ slidefield [options] [file ...]
+
+### Comments
+
+    % single-line comment
+    %{ multi-line
+       comment %}
+
+### Variables
+
+A variable can only be created once inside each object (with the `=` operator).
+However they can be modified freely using any other available operator.
+The type of the variable cannot be changed after the variable creation.
+
+    variable  = value
+    variable += value
+    variable -= value
+    variable *= value
+    variable /= value
+
+
+### Value types
+
+Integers:
+
+    variable = 42
+    variable += 2  % add
+    variable -= 10 % subtract
+    variable *= 6  % multiply
+    variable /= 10 % divide
+    % variable is 20
+
+Character strings:
+
+    variable = "hello"
+    variable += " world!\n" % append
+    variable -= "!"         % remove the bang
+    variable *= "3"         % multiply by 3
+    % variable is "hello world\nhello world\nhello world\n"
+
+Size or point coordinates:
+
+    variable = 2x4
+    variable += 100x80 % add
+    variable -= 10x0   % subtract
+    variable *= 3x4    % multiply
+    variable /= 2x2    % divide
+    % variable is 138x168
+
+Colors (red, blue, green & alpha in hexadecimal notation):
+
+    variable = #C0FF33FF
+    variable += #03003300 % add
+    variable -= #0C240055 % subtract
+    % variable is #B7DB66AA
+
+Booleans:
+
+    variable = :true
+    opposite = :false
+
+Variables can also store custom objects. See the 'Templates' section below.
+
+### Objects
+
+Variables are bound to the object in which they are created into.
+Most SlideField object have reserved variables ("*properties*")
+with a predefined type.
+All properties are mandatory unless otherwise specified.
+
+Nested objects inherit their parent's variables.
+All slide objects (marked as such in the list below) can be infinitely nested.
+
+    % Syntax:
+    \object_name
+    \object_name { ... }
+    \object_name value
+    \object_name value { ... }
+
+The shortcut syntax `\object value` assigns `value` to the first property
+compatible with the value's type.
+
+### Object List
+
+**(Anywhere)** Load another file at the current location:
+
+    \include "relative/path/to/file.sfp"
+    \include {
+      source = "relative/path/to/file.sfp"
+    }
+
+**(Anywhere)** Print debug information about any value to standard output:
+
+    \debug any_value
+
+**(Top-level, required, maximum 1)** Configure the output window:
+
+    \layout 1920x1080
+    \layout {
+      size = 1920x1080
+      fullscreen = :true % optional
+    }
+
+**(Top-level, required)** Create a slide:
+
+    \slide { ... }
+
+**(Slide)** Animation between slides:
+
+    \animation "fade" { ... }
+    \animation {
+      name = "fade"
+      %{
+      other possible values are:
+      name = "slide right"
+      name = "slide left"
+      name = "slide down"
+      name = "slide up"
+      name = "zoom"
+      %}
+      duration = 400 % in ms (optional)
+    }
+*Note: The animation is applied only to nested objects.*
+
+**(Slide)** Add an image:
+
+    \image "relative/path/to/image.png"
+    \image {
+      source = "relative/path/to/image.png"
+      size = 0x0        % automatic if 0 (optional)
+      color = #FFFFFFFF % color filter (optional)
+      position = 0x0    % optional
+      z_order = 0       % optional
+    }
+
+**(Slide)** Add a rectangle:
+
+    \rect 100x100
+    \rect {
+      size = 100x100
+      fill = #FFFFFFFF % optional
+      position = 0x0   % optional
+      z_order = 0      % optional
+    }
+
+**(Slide)** Play an audio file:
+
+    \song "relative/path/to/audio.ogg"
+    \song {
+      source = "relative/path/to/audio.ogg"
+      volume = 100 % optional
+      loop = :true % optional
+    }
+
+**(Slide)** Add text:
+
+    \text "Hello World!"
+    \text {
+      content = "Hello World!"
+      color = #FFFFFFFF % optional
+      font = "sans"     % font name or relative font path (optional)
+      % font = "./my_font.ttf"
+      height = 20       % font height in pixels (optional)
+      width = 0         % maximum width (automatic if 0, optional)
+      spacing = 0       % line spacing (optional)
+      align = "left"    % optional
+      %{
+      other possible values are:
+      align = "right"
+      align = "center"
+      align = "justify"
+      %}
+      position = 0x0 % optional
+      z_order = 0    % optional
+    }
+
+### Filters
+Filters are like methods in an object-oriented programming language.
+They can be chained infinitely.
+
+    variable = (filter)value
+    variable = (second_filter)(first_filter)value
+
+Point to integer:
+
+    point = 1920x1080
+    x = (x)point
+    % x is 1920
+
+    y = (y)point
+    % y is 1080
+
+Integer to point:
+
+    point = (x)1920
+    % point is 1920x0
+
+    point += (y)1080
+    % point is 1920x1080
+
+Line count:
+
+    lines = (lines)"Lorem\nIpsum"
+    % lines is 2
+
+### Templates
+Custom objects can be created using templates.
+
+    template_name = \object_name { ... }
+    \&template_name
+
+    % creation
+    slide_template = \slide {
+      \image background { size = 1920x1080; }
+      \text title { height = 72; }
+    }
+
+    % usage
+    \&slide_template {
+      title = "Hello World!"
+      background = "relative/path/to/image.png"
+    }
+
+Equivalent of the above example without using templates:
+
+    \slide {
+      title = "Hello World!"
+      background = "relative/path/to/image.png"
+      \image background { size = 1920x1080; }
+      \text title { height = 72; }
+    }
+
+## Contributing
+
+1. [Fork it](https://bitbucket.org/cfi30/slidefield/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Test your changes (`rake`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => [:test]
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/helper.rb', 'test/test_*.rb']
+end

data/bin/slidefield

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'slidefield'
+require 'optparse'
+
+def parse_opts
+  options = []
+
+  OptionParser.new do |opts|
+    opts.program_name = "SlideField"
+    opts.version = SlideField::VERSION
+    opts.banner = "Usage: slidefield [options] [file ...]"
+
+    opts.on '-c', '--check', "Check input only" do
+      options << :check
+    end
+
+    opts.on_tail '-v', '--version', "Show version number and copyright" do
+      puts opts.ver
+      puts <<GPL
+Copyright (C) 2014 by Christian Fillion
+
+    This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License as
+published by the Free Software Foundation, either version 3 of
+the License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+GPL
+      exit
+    end
+
+    opts.on_tail '-h', '--help', "Show this message" do
+      puts opts.help
+      exit
+    end
+  end.parse!
+
+  options
+end
+
+begin
+  begin
+    options = parse_opts
+  rescue OptionParser::InvalidOption => e
+    raise SlideField::Error, e
+  end
+
+  files = ARGV
+
+  # read from standard input by default
+  files << '-' if files.empty?
+
+  files.each {|file|
+    interpreter = SlideField::Interpreter.new
+    if '-' == file
+      interpreter.run_string STDIN.read
+    else
+      path = File.absolute_path file
+      interpreter.run_file path
+    end
+
+    next if options.include? :check
+
+    project_root = interpreter.root
+    viewer = SlideField::Viewer.new project_root
+    viewer.caption = project_root.context
+    viewer.show
+  }
+rescue SlideField::Error => e
+  warn "#{e.class}: #{e}"
+rescue Interrupt
+  puts
+end

data/examples/complete/main.sfp

@@ -0,0 +1,7 @@
+\include "variables.sfi"
+\include "templates.sfi"
+
+\layout layout_size
+
+\include "slides/mountains.sfi"
+\include "slides/deserts.sfi"

data/examples/complete/slides/deserts.sfi

@@ -0,0 +1,19 @@
+\&slide_tpl {
+  title = "Sahara"
+
+  infos  = "<b>Area:</b> 9,400,000 km²\n"
+  infos += "<b>Notes:</b> The world's hottest desert"
+
+  background_src  = "../assets/sahara.jpg"
+  background_link = "https://en.wikipedia.org/wiki/File:Sahara_satellite_hires.jpg"
+}
+
+\&slide_tpl {
+  title = "Gobi"
+
+  infos  = "<b>Area:</b> 1,295,000 km²\n"
+  infos += "<b>Notes:</b> The expansion of the Gobi is\nattributed mostly to human activities"
+
+  background_src  = "../assets/gobi.jpg"
+  background_link = "https://en.wikipedia.org/wiki/File:Khongoryn_Els,_Gurvansaikhan_NP,_Gobi_desert,_Mongolia.jpg"
+}

data/examples/complete/slides/mountains.sfi

@@ -0,0 +1,25 @@
+\&slide_tpl {
+  title = "Mount Everest"
+
+  infos  = "<b>Country:</b> Nepal\n"
+  infos += "<b>Elevation:</b> 8,848 m\n"
+  infos += "<b>First ascent:</b> 29 May 1953\n"
+  infos += "<b>Easiest route:</b> South Col\n"
+  infos += "<b>Notes:</b> Earth's highest mountain"
+
+  background_src  = "../assets/mount_everest.jpg"
+  background_link = "https://en.wikipedia.org/wiki/File:Mount_Everest_as_seen_from_Drukair2_PLW_edit.jpg"
+}
+
+\&slide_tpl {
+  title = "K2"
+
+  infos  = "<b>Country:</b> Pakistan\n"
+  infos += "<b>Elevation:</b> 8,611 m\n"
+  infos += "<b>First ascent:</b> 31 July 1954\n"
+  infos += "<b>Easiest route:</b> Abruzzi Spur\n"
+  infos += "<b>Notes:</b> The mountain was first\nsurveyed by a European team in 1856"
+
+  background_src  = "../assets/K2.jpg"
+  background_link = "https://en.wikipedia.org/wiki/File:K2_2006b.jpg"
+}

data/examples/complete/templates.sfi

@@ -0,0 +1,95 @@
+background_tpl = \image {
+  size = layout_size
+}
+
+title_tpl = \text {
+  color = #FFFFFFFF
+  font = title_font
+  height = 100
+  position = 100x70
+  z_order = 1
+
+  % support alignment
+  x = (x)position
+  x *= 2
+  width = (x)layout_size
+  width -= x
+
+  % shadow
+  \text #00000099 {
+    position += 2x2
+    z_order -= 1
+  }
+}
+
+infobox_tpl = \rect {
+  padding = 10
+  text_height = 40
+  z_order = 1
+
+  box_height = (lines)content
+  box_height *= text_height
+  box_height += padding
+
+  size = 650x0
+  size += (y)box_height
+
+  position = layout_size
+  position -= size
+  position /= 2x1
+  position -= 0x100
+
+  fill = #FFFFFF69
+
+  \text {
+    position += (x)padding
+    position += (y)padding
+
+    height = text_height
+    color = #011010FF
+    font = info_font
+
+    % shadow
+    \text {
+      position += 1x1
+      color = #FFFFFF99
+      z_order -= 1
+    }
+  }
+}
+
+credit_tpl = \text {
+  position = 10x-30
+  position += (y)(y)layout_size
+
+  color = #FFFFFFFF
+  z_order = 1
+
+  \text {
+    position += 1x1
+    color = #000000FF
+    z_order -= 1
+  }
+}
+
+slide_tpl = \slide {
+  \animation "fade" {
+    \&background_tpl background_src
+  }
+
+  \&title_tpl {
+    content = "<b>"
+    content += title
+  }
+
+  \animation "slide left" {
+    \&infobox_tpl {
+      content = infos
+    }
+  }
+
+  \&credit_tpl {
+    content = "<b>Photo Credit:</b> "
+    content += background_link
+  }
+}

data/examples/complete/variables.sfi

@@ -0,0 +1,6 @@
+% ---- LAYOUT ---- %
+layout_size = 1920x1080
+
+% ---- SLIDES ---- %
+title_font = "URW Bookman L"
+info_font = "monospace"

data/examples/minimal/main.sfp

@@ -0,0 +1,43 @@
+layout_size = 1366x768
+
+\layout layout_size
+
+\slide {
+  \text "Hello World!" { height = 50; }
+  \text "Press <b>Enter</b> to display the next slide" {
+    position = 0x50
+  }
+}
+
+\slide {
+  \text "Second Slide"
+  \text "Press <b>Backspace</b> to return to the previous slide" {
+    position = 0x30
+    width = 200
+  }
+
+  \text "This example contains 3 slides.\n(Press <b>Enter</b> again)" {
+    position = 0x70
+    width = (x)layout_size
+    align = "right"
+  }
+}
+
+\slide {
+  \rect {
+    fill = #FFFFFFFF % RRGGBBAA
+    size = layout_size
+  }
+
+  \image "ruby-logo.png" {
+    position = layout_size
+    position -= 62x62
+    position /= 2x2
+  }
+
+  \text {
+    content = "Last Slide\nPress <b>Escape</b> to quit"
+    color = #000000FF
+    font = "monospace"
+  }
+}

data/lib/slidefield/animator.rb

@@ -0,0 +1,104 @@
+class SlideField::Animator
+  attr_accessor :current, :forward
+
+  def initialize(layout_size)
+    @layout_size = layout_size
+    reset
+  end
+
+  def need_redraw?
+    @animations.each {|k,v| return true if v.enabled }
+    @animations.empty?
+  end
+
+  def reset
+    @animations = {}
+  end
+
+  def frame(*args)
+    struct = Struct.new :time, :current?, :forward?
+    @frame = struct.new *args
+    yield
+    @frame = nil
+  end
+
+  def transform(obj)
+    raise "Can not animate outside a frame" unless @frame
+
+    tr_struct = Struct.new :skip_draw?, :x_offset, :y_offset, :scale, :opacity
+    tr = tr_struct.new false, 0, 0, 1.0, 1.0
+
+    anim = animation_for obj.ancestor(:animation)
+
+    # no animation
+    return tr if anim.nil?
+
+    elapsed = @frame.time - anim.start_time
+    position = elapsed / anim.duration
+    anim.enabled = false if position > 1.0
+
+    # animation finished
+    unless anim.enabled
+      tr[:skip_draw?] = !@frame.current? # don't draw the previous slide anymore
+      return tr
+    end
+
+    width, height = @layout_size
+
+    case anim.name
+    when "fade"
+      if @frame.current?
+        tr.opacity = position
+      else
+        tr.opacity = 1.0 - position
+      end
+    when "slide right"
+      tr.x_offset = slide_offset position, width, false
+    when "slide left"
+      tr.x_offset = slide_offset position, width, true
+    when "slide down"
+      tr.y_offset = slide_offset position, height, false
+    when "slide up"
+      tr.y_offset = slide_offset position, height, true
+    when "zoom"
+      if @frame.current?
+        tr.scale = position
+      else
+        tr.scale = 1.0 - position
+      end
+    else
+      # the validator has missed ?!
+      # TODO: validate at interpret time
+      raise SlideField::RuntimeError,
+        "Unsupported animation '#{anim.name}'"
+    end
+
+    tr
+  end
+
+  private
+  def animation_for(data)
+    return @animations[data] if @animations.has_key? data
+
+    anim_struct = Struct.new :enabled, :start_time, :name, :duration
+    anim = anim_struct.new false, 0.0, '', 0
+
+    if data
+      anim.enabled = true
+      anim.start_time = @frame.time.to_f
+      anim.name = data.get :name
+      anim.duration = data.get :duration
+    end
+
+    @animations[data] = anim
+  end
+
+  def slide_offset(position, size, inverse)
+    inverse = !inverse unless @frame.forward?
+
+    offset = size * position
+    offset -= size if @frame.current?
+    offset = 0 - offset if inverse
+    offset
+  end
+end

data/lib/slidefield/errors.rb

@@ -0,0 +1,6 @@
+module SlideField
+  class Error < RuntimeError; end
+  class ParseError < Error; end
+  class InterpreterError < Error; end
+  class RuntimeError < Error; end
+end