ontomde-core 1.0.2 → 1.0.4

data/lib/ontomde-core/helper.rb

@@ -1,538 +1,547 @@
-#:include: ../shared/license.rdoc
-
-require 'fileutils'
-#require 'ontomde-core/exceptions.rb'
-#require 'ontomde-core/fileTypes.rb'
- 
-class WarningReverseBadOrMissingEnd < Warning
-end
-
-#Internal use.
-class LoadModelLazyWriter
-
-#Internal use.
-	def initialize (fn,ft)
-		@fileName=fn
-		@fileType=ft
-		@model=nil
-		@usedResources=nil
-	end
-	def fileType
-		if @fileType.nil?
-			@fileType=FileType.getFileType(@fileName)
-		end
-		return @fileType
-	end
-
-#Internal use.
-	def protectedMode?
-		return !@model.nil?
-	end	
-		
-	def [](key)
-		if @model.nil?
-			@model=Crdf_Model.new
-			@model.mtk_retrieveProtected(@fileName,fileType)
-		end
-		if @usedResources.nil?
-			@usedResources=Array.new
-		end
-		ret=@model[key]
-		@usedResources << key unless ret.nil?
-		return ret
-	end
-	
-	def unusedData
-		return nil if @model.nil?
-		ret=nil
-		@model.each { |k,c|
-			next if @usedResources.include?(k)
-			# c is either a String or a bootstrap element.
-			next if c.kind_of?(Mrdf_Resource) && c.ext_isBootstrap?
-			ret=Array.new if ret.nil?
-			ret << k
-		}
-		return ret
-	end
-
-end
-module Mmtk_helper
-
-end
-
-module Mrdf_Resource
-	include Mmtk_helper
-end
-
-class Crdf_Model
-include Mmtk_helper
-end
-class Crdf_Resource
-include Mmtk_helper
-end
-
-module Mrdf_Model
-include Mmtk_helper
-end
-module Mmtk_helper
-# Internal use.
-#
-# Used primarily by mtk server
-def mtk_stringWriteSession()
-	fileName=context.get(:mtk_filename)
-	fileName='string-file' if fileName.nil?
-	file=StringOutputStream.new
-
-	ret=nil
-	mtk_context(:mtk_out=>file,:mtk_fileName=>fileName) {
-		@@mtk_out=context[:mtk_out] # perf
-		yield
-		ret=@@mtk_out.to_s
-	}
-	@@mtk_out=context.get(:mtk_out) # perf
-	return ret
-end
-
-#mtk_writeSession temporary file suffix.
-TEMP_FILE_SUFFIX=".xmda_toolkit_temporary"
-
-@@max_file_logged=30
-
-#le fichier fileName a ete genere pour la resource res 
-	attr_reader :fileGenerated
-	#@fileGenerated=Array.new
-	def notifyFileGenerated(fileName,res)
-		#@fileGenerated << [ fileName , res ]
-	end
-
-#Opens a file for writing. 
-#Note: 
-#  Existing file is deleted
-#  Directory are automatically created
-#  Write is atomic. In case of failure existing file is not affected.
-#  The name of the current file is available in context: context[:mtk_fileName]
-#
-# if context[:dryRun] is true, file writes will be skipped. 
-# Note that reverse (file read) **will** be performed however.
-#Example:
-#mtk_writeSession('file1.java') {
-#		write('this goes into file1.java')
-#		mtk_writeSession('file2.java') {
-#			write('this goes into file2.java')
-#			puts context[:mtk_fileName]
-#		}
-#		write('this goes into file1.java')
-#	}
-MTK_WRITE_SESSION_FILE_NAMES=Set.new
-def mtk_writeSession(fileName,fileType=nil)
-	# Open or create session
-	mtk_writeSessionNameClashErrorDetection(fileName.to_s)
-
-	protectedReverse=LoadModelLazyWriter.new(fileName,fileType)
-	FileUtils.mkdir_p(File.dirname(fileName))
-	notifyFileGenerated(File.expand_path(fileName),self)
-
-	doNotOverwrite=mtk_autoNewFileCreationCheck(fileName)
-	if context[:dryRun,false]
-		file=NullFileWriter.instance
-		log.debug { "Simulating Write to #{fileName} (because context[:dryRun]==true)" }
-		mtk_context(:mtk_out=>file,:mtk_fileName=>fileName,:protectedReverse=>protectedReverse) {
-			@@mtk_out=context[:mtk_out] # perf
-			yield
-		}
-		@@mtk_out=context.get(:mtk_out) # perf
-		return 
-	end
-	File.open(fileName+TEMP_FILE_SUFFIX,File::CREAT|File::TRUNC|File::RDWR, 0644) { 
-		|file| 
-		mtk_context(:mtk_out=>file,:mtk_fileName=>fileName,:protectedReverse=>protectedReverse) {
-		log.debug { "Writing #{fileName}" }
-			@@mtk_out=context[:mtk_out] # perf
-			yield 
-		}
-		@@mtk_out=context.get(:mtk_out) # perf
-		}	
-	#Le fichier temporaire a bien �t� g�n�r�.
-	unusedData=protectedReverse.unusedData
-	if(!unusedData.nil?)
-		log.info { "warning: saved code appended to #{fileName}.mtk_save" }
-		msg=""
-		File.open(fileName+".mtk_save",File::CREAT|File::APPEND|File::RDWR, 0644) { |file| 
-			unusedData.each {|k| 
-				msg=msg+%{\n  ** uri="#{k}"}
-				file.write <<END
-//***********************
-//XMDA BEGIN SAVED DATA : uri="#{k}"
-//***********************
-#{protectedReverse[k]}
-//***********************
-//END SAVED DATA
-//***********************
-
-END
-
-		}
-		}
-		if !context[:allowAutomaticCodeDeletion,false]
-			doNotOverwrite=true 
-			log.error { %{
-***************************************************************
-Code generation has been *halted* to prevent code loss in
-     #{fileName}
-
-Code to be deleted is stored in
-     #{fileName}.mtk_save
-
-You must take the appropriate actions before re-running generator.
-* fix your model for unwanted deletion.
-* manually delete unused code for #{msg}
-* rename 
-     #{fileName+TEMP_FILE_SUFFIX} 
-  to
-     #{fileName} 
-#
-***************************************************************
-}}
-			#exit(1)
-		end
-	
-	end
-
-	puts "Writing: #{fileName}" if context[:logFileWrite,false]
-	retryCount=0
-	while true 
-			begin
-				# On some windows machine, 
-				# file is sometimes locked by some management 
-				# daemon (probably some corporate audit daemon)
-				# This cause code generation to fail.
-				# This loop gives the daemon a chance to
-				# unlock the file.
-				# We just wait a few seconds and try again.
-				#raise IOException.new(),"KO" if retryCount<2
-				File.rename(fileName+TEMP_FILE_SUFFIX,fileName)
-				puts "Retry succeeded." if retryCount>0
-				break # exit while
-			rescue   => e
-				retryCount=retryCount+1
-				#log.warn "#{e}"
-				raise e if retryCount > 3 
-				puts "Rename failed. Retrying (#{retryCount})"
-				sleep(2) # 
-			end	
-	end
-	return nil
-end
-
-#checks if fileName already exists
-def mtk_autoNewFileCreationCheck(fileName)
-	doNotOverwrite=!context[:autoNewFileCreation,true] && !File.exists?(fileName)
-	if doNotOverwrite
-		# xmda is not allowed to create new file
-		log.error { %{
-********* NEW FILE DETECTED **********
-** A new file needs to be added to your project:
-** "#{fileName}"
-**
-** Generator has been halted to let 
-** you take proper actions such as:
-**
-**  * Refactor your code if this new file is a renamed file
-**  * Create a blank file and Add this file to version control 
-** 
-** Model Element being processed is:
-** #{mtk_object_message}
-**
-** Model element being processed is related to:
-** #{mtk_related_message}
-********* NEW FILE DETECTED **********
-}}
-	#exit(1)
-	end
-	return doNotOverwrite
-end
-
-#detects if fileName has already been used.
-#Logs an error if a clash is detected.
-def mtk_writeSessionNameClashErrorDetection(fileName)
-	if(MTK_WRITE_SESSION_FILE_NAMES.include?(fileName.to_s)) 
-		log.error{ %{********* NAME CLASH DETECTED ********** #{fileName}
-********* NAME CLASH DETECTED **********
-** This software has detected that a generated file 
-** is being overwritten in the same code generation session.
-** This most likely is caused by a name clash in the source model.
-**
-** Filename being overwritten is 
-** "#{fileName}"
-** Model Element being processed is:
-** #{mtk_object_message}
-**
-** Model element being processed is related to:
-** #{mtk_related_message}
-********* NAME CLASH DETECTED **********
-}}
-	else
-		MTK_WRITE_SESSION_FILE_NAMES<< fileName.to_s
-	end
-	end	
-
-#writes before string, 
-#yield block and then writes after.
-#
-#EXAMPLE.
-# encloseWrite("<title>","</title>") { write "Today news" }
-def encloseWrite(beforeStr,afterStr,&middleBlock)
-		write(beforeStr.to_s)
-		yield
-		write(afterStr.to_s)	
-end
-
-# Write string to the current file opened by mtk_writeSession.
-def write(str)
-	if !@@mtk_out.nil? 
-		@@mtk_out.write(str)
-		return
-	end
-	raise Warning.new(), <<END
-There is no file currently opened.  
-Please use mtk_writeSession prior to using any write method.
-Example:
-#  mtk_writeSession('file1.java') {
-#    write("Package .... ;")
-#       }
-#  }
-END
-end
-
-# Internal use.
-# 
-# Transforms a uri to a uri qualified by the current file name
-def mtk_qualifyBlockURI(_uri)
-	return "#{_uri}__#{context[:mtk_fileName]}"
-end
-
-#def mtk_fileType
-#	fileType=nil
-#	puts "fileType1=#{fileType}"
-#	fileType=context.get(:mtk_fileType)
-#	puts "fileType2=#{fileType}"
-#	fileType=FileType.get(fileName) if fileType.nil?
-#	puts "fileType3=#{fileType}"
-#
-#	#fileType=FileTypeJava.instance
-#	return fileType
-#end
-
-#
-# Internal use.
-#
-# Reverse the file currently being written by mtk_writeSession.
-# This method is automaticaly called
-def mtk_retrieveProtected(fileName,fileType)
-	return false unless File.exists?(fileName)
-
-	mtk_context(:mtk_fileName=>fileName) {
-	File.open(fileName,'r') { |aFile|
-		i=0
-		reading=false
-		block_uri=nil
-		buffer=''
-		reverseMode=nil
-
-		aFile.each_line { |line|
-			i=i+1
-			if !reading
-				#return if !line.include?("PROTECTED REGION XMDA BEGIN") # optimisation ?
-				m=fileType.re_begin.match(line)
-				log.debug {"beg match_ok=#{!m.nil?} line=#{line}"}
-				next if m.nil?
-				#raise Warning.new,"Error Reading Protected region header\n#{fileName}:line #{i}: #{line}" if m.nil?
-				reading=true
-				buffer=''
-				linesep=''
-				block_uri=fileType.unescape(m[2].to_s)
-				log.debug { "ma: #{m[0]} block_uri=#{block_uri}" }
-				raise Warning.new,'Error Reading Protected region header nil uri' if block_uri.nil?
-				case m[1] 
-					when 'yes' then reverseMode=true
-					when 'no'  then reverseMode=false
-				else raise Warning.new,%{Bad reverseMode value in file #{fileName}. reverse="yes" or reverse="no" expected (got "#{m[1]}" line ##{i}).}
-	end
-				raise Warning.new,'Error Reading Protected region header nil uri' if reverseMode.nil? 
-				log.debug { "!!!!!! block_ri=--#{block_uri}--" }
-			else
-				#log.debug "#{reading} line=#{line}"
-				m=fileType.re_end.match(line)
-				#log.debug "end match_ok=#{!m.nil?} line=#{line}"
-				if m.nil?
-					buffer=buffer.nil? ?  line : "#{buffer}#{line}"
-					next
-				end
-				block_uri_end=fileType.unescape(m[1].to_s)
-				if block_uri_end!=block_uri
-					raise WarningReverseBadOrMissingEnd.new, <<ENDERRORMSG
-Bad non matching END tag in  #{fileName} 
-  expected uri="#{block_uri}" 
-  and got  uri="#{block_uri_end}" 
-  line ##{i})
-ENDERRORMSG
-				end
-				reading=false
-				#log.debug "block_uri=#{block_uri} protected ->xxxxxxx\n#{buffer}xxxxxxxxxx"
-				qualified_block_uri=mtk_qualifyBlockURI(block_uri)
-				if reverseMode
-					self[qualified_block_uri]=buffer[0,buffer.size-1]
-				else
-					#log.debug "Reverse ignored #{context[:mtk_fileName]}!"
-				end
-			end
-
-		}
-	}}
-	return true # un fichier a ete retro
-end
-end
-
-#module Mrdf_Resource
-#end
-module Mmtk_helper #_Resource
-REVERSE=true
-NOREVERSE=false
-
-# mtk_protected is used when generated code can be modified by user and preserved by subsequent generation.
-# The code generated in the block passed as parameter will be generated encolosed between identifiable tags.
-# 
-# NOTE:
-#    The block is identified by the current rdf resource URI.
-#    If more than one block is to be generated in one file, zoneId must be used.
-#
-#
-#
-#
-#Example 1: default 
-#  mtk_writeSession('file1.java') {
-#    write("Package .... ;")
-#    a.mtk_protected() {
-#       write("default code to be redefined by user");
-#       }
-#    b.mtk_protected() {
-#       write("default code to be redefined by user");
-#       }
-#  }
-#Example 2: initial mode is reverse 
-#  mtk_writeSession('file1.java') {
-#    write("Package .... ;")
-#    mtk_protected(REVERSE) {
-#       write("default code to be redefined by user");
-#       }
-#  }
-#Example 3: initial mode is noreverse 
-#  mtk_writeSession('file1.java') {
-#    write("Package .... ;")
-#    mtk_protected(NOREVERSE) {
-#      write("default code to be redefined by user");
-#      }
-#  }
-#Example 4: multiple-protected zone for a single object
-#  mtk_writeSession('file1.java') {
-#    write("Package .... ;")
-#    a.mtk_protected(REVERSE,"a") {
-#       write("default code to be redefined by user");
-#       }
-#    a.mtk_protected(REVERSE,"b") {
-#       write("default code to be redefined by user");
-#       }
-#  }
-def mtk_protected(initialReverseMode=false,zoneId='0',&block)
-	#mbu=mtk_block_uri
-	mbu="#{rdf_uri}__#{zoneId}"
-	qualified_uri=rdf_model.mtk_qualifyBlockURI(mbu)
-	
-	fileType=context[:protectedReverse].fileType
-	str=context[:protectedReverse][qualified_uri]
-
-	reverse= (!str.nil?) || initialReverseMode
-
-	write(fileType.beginMarker(mbu,reverse))
-	
-	if str.nil?
-		#log.debug "!!yield block_uri=#{mbu}"
-		yield
-	else
-		write(str)
-	end
-	write(fileType.endMarker(mbu))
-end	
-
-#Stream to String Session
-def mtk_stss(&block)
-	#@rdf_model.mtk_stringWriteSession(&block)
-	mtk_stringWriteSession(&block)
-end
-
-#internal method.
-#
-#Returns file descriptor currently used by mtk_writeSession.
-def mtk_out
-	return context[:mtk_out]
-end
-
-end
-
-#Internal use.
-#
-#Used by mtk_stringWriteSession.
-class StringOutputStream 
-def initialize
-	@str=nil
-end
-
-# Internal use.
-#
-# Simulates file open
-def open ; end
-
-# Internal use.
-#
-# Simulates file open
-def close ; end
-
-# Internal use.
-#
-# Appends str to internal steam buffer
-def write (str)
-	#log.debug "Ajout #{str.to_s} !!"
-	if @str
-		@str="#{@str}#{str.to_s}"
-	else
-		@str=str.to_s
-	end
-end
-
-# Internal use.
-# returns the internal stream buffer
-def to_s
-	return @str
-end
-end
-
-
-
-module Mcore_Product
-end
-
-class Ccore_Product < Crdfs_Class
-	include Mcore_Product
-	def generate
-	end
-	
-end
-
-# a file writer that writes nowhere
-class NullFileWriter
-	include Singleton
-	def write(str)
-		# does nothing ! 
-	end
-end
-
+require 'fileutils'
+
+class WarningReverseBadOrMissingEnd < Warning
+end
+
+#Internal use.
+class LoadModelLazyWriter
+
+  #Internal use.
+  def initialize (fn,ft)
+    @fileName=fn
+    @fileType=ft
+    @model=nil
+    @usedResources=nil
+  end
+  def fileType
+    if @fileType.nil?
+      @fileType=FileType.getFileType(@fileName)
+    end
+    return @fileType
+  end
+
+  #Internal use.
+  def protectedMode?
+    return !@model.nil?
+  end
+
+  def [](key)
+    if @model.nil?
+      @model=Crdf_Model.new
+      @model.mtk_retrieveProtected(@fileName,fileType)
+    end
+    if @usedResources.nil?
+      @usedResources=Array.new
+    end
+    ret=@model[key]
+    @usedResources << key unless ret.nil?
+    return ret
+  end
+
+  def unusedData
+    return nil if @model.nil?
+    ret=nil
+    @model.each { |k,c|
+      next if @usedResources.include?(k)
+      # c is either a String or a bootstrap element.
+      next if c.kind_of?(Mrdf_Resource) && c.ext_isBootstrap?
+      ret=Array.new if ret.nil?
+      ret << k
+    }
+    return ret
+  end
+
+end
+module Mmtk_helper
+
+end
+
+module Mrdf_Resource
+  include Mmtk_helper
+end
+
+class Crdf_Model
+  include Mmtk_helper
+end
+class Crdf_Resource
+  include Mmtk_helper
+end
+
+module Mrdf_Model
+  include Mmtk_helper
+end
+module Mmtk_helper
+  # Internal use.
+  #
+  # Used primarily by mtk server
+  def mtk_stringWriteSession()
+    fileName=context[:mtk_fileName,'string-file']
+    file=StringOutputStream.new
+
+    ret=nil
+    mtk_context(:mtk_out=>file,:mtk_fileName=>fileName) {
+      @@mtk_out=context[:mtk_out] # perf
+      yield
+      ret=@@mtk_out.to_s
+    }
+    @@mtk_out=context.get(:mtk_out) # perf
+    return ret
+  end
+
+  #mtk_writeSession temporary file suffix.
+  TEMP_FILE_SUFFIX=".xmda_toolkit_temporary"
+
+  @@max_file_logged=30
+
+  #le fichier fileName a ete genere pour la resource res
+  attr_reader :fileGenerated
+  #@fileGenerated=Array.new
+  def notifyFileGenerated(fileName,res)
+    #@fileGenerated << [ fileName , res ]
+  end
+
+  #Opens a file for writing.
+  #Note:
+  #  Existing file is deleted
+  #  Directory are automatically created
+  #  Write is atomic. In case of failure existing file is not affected.
+  #  The name of the current file is available in context: context[:mtk_fileName]
+  #
+  # if context[:dryRun] is true, file writes will be skipped.
+  # Note that reverse (file read) **will** be performed however.
+  #Example:
+  #mtk_writeSession('file1.java') {
+  #		write('this goes into file1.java')
+  #		mtk_writeSession('file2.java') {
+  #			write('this goes into file2.java')
+  #			puts context[:mtk_fileName]
+  #		}
+  #		write('this goes into file1.java')
+  #	}
+  MTK_WRITE_SESSION_FILE_NAMES=Set.new
+  def mtk_writeSession(fileName,fileType=nil)
+    # Open or create session
+    mtk_writeSessionNameClashErrorDetection(fileName.to_s)
+
+    protectedReverse=LoadModelLazyWriter.new(fileName,fileType)
+    FileUtils.mkdir_p(File.dirname(fileName))
+    notifyFileGenerated(File.expand_path(fileName),self)
+
+    doNotOverwrite=mtk_autoNewFileCreationCheck(fileName)
+    if context[:dryRun,false]
+      file=NullFileWriter.instance
+      #log.debug { "Simulating Write to #{fileName} (because context[:dryRun]==true)" }
+      mtk_context(:mtk_out=>file,:mtk_fileName=>fileName,:protectedReverse=>protectedReverse) {
+        @@mtk_out=context[:mtk_out] # perf
+        yield
+      }
+      @@mtk_out=context.get(:mtk_out) # perf
+      return
+    end
+    File.open(fileName+TEMP_FILE_SUFFIX,File::CREAT|File::TRUNC|File::RDWR, 0644) {
+      |file|
+      mtk_context(:mtk_out=>file,:mtk_fileName=>fileName,:protectedReverse=>protectedReverse) {
+        #log.debug { "Writing #{fileName}" }
+        @@mtk_out=context[:mtk_out] # perf
+        yield
+      }
+      @@mtk_out=context.get(:mtk_out) # perf
+    }
+    #Le fichier temporaire a bien �t� g�n�r�.
+    unusedData=protectedReverse.unusedData
+    if(!unusedData.nil?)
+      log.info { "warning: saved code appended to #{fileName}.mtk_save" }
+      msg=""
+      File.open(fileName+".mtk_save",File::CREAT|File::APPEND|File::RDWR, 0644) { |file|
+        unusedData.each {|k|
+          msg=msg+%{\n  ** uri="#{k}"}
+          file.write <<END
+//***********************
+//XMDA BEGIN SAVED DATA : uri="#{k}"
+//***********************
+#{protectedReverse[k]}
+//***********************
+//END SAVED DATA
+//***********************
+
+END
+
+        }
+      }
+      if !context[:allowAutomaticCodeDeletion,false]
+        doNotOverwrite=true
+        log.error { %{
+***************************************************************
+Code generation has been *halted* to prevent code loss in
+     #{fileName}
+
+Code to be deleted is stored in
+     #{fileName}.mtk_save
+
+You must take the appropriate actions before re-running generator.
+* fix your model for unwanted deletion.
+* manually delete unused code for #{msg}
+* rename
+     #{fileName+TEMP_FILE_SUFFIX}
+  to
+     #{fileName}
+#
+***************************************************************
+          }}
+        #exit(1)
+        raise Exception.new("potential code loss detected")
+      end
+
+    end
+
+    puts "Writing: #{fileName}" if context[:logFileWrite,false]
+    retryCount=0
+    while true
+      begin
+        # On some windows machine,
+        # file is sometimes locked by some management
+        # daemon (probably some corporate audit daemon)
+        # This cause code generation to fail.
+        # This loop gives the daemon a chance to
+        # unlock the file.
+        # We just wait a few seconds and try again.
+        #raise IOException.new(),"KO" if retryCount<2
+        File.rename(fileName+TEMP_FILE_SUFFIX,fileName)
+        puts "Retry succeeded." if retryCount>0
+        break # exit while
+      rescue   => e
+        retryCount=retryCount+1
+        #log.warn "#{e}"
+        raise e if retryCount > 3
+        puts "Rename failed. Retrying (#{retryCount})"
+        sleep(2) #
+      end
+    end
+    return nil
+  end
+
+  #checks if fileName already exists
+  def mtk_autoNewFileCreationCheck(fileName)
+    doNotOverwrite=!context[:autoNewFileCreation,true] && !File.exists?(fileName)
+    if doNotOverwrite
+      # xmda is not allowed to create new file
+      log.error { %{
+********* NEW FILE DETECTED **********
+** A new file needs to be added to your project:
+** "#{fileName}"
+**
+** Generator has been halted to let
+** you take proper actions such as:
+**
+**  * Refactor your code if this new file is a renamed file
+**  * Create a blank file and Add this file to version control
+**
+** Model Element being processed is:
+** #{mtk_object_message}
+**
+** Model element being processed is related to:
+** #{mtk_related_message}
+********* NEW FILE DETECTED **********
+        }}
+      #exit(1)
+    end
+    return doNotOverwrite
+  end
+
+  #detects if fileName has already been used.
+  #Logs an error if a clash is detected.
+  def mtk_writeSessionNameClashErrorDetection(fileName)
+    if(MTK_WRITE_SESSION_FILE_NAMES.include?(fileName.to_s))
+      log.error{ %{********* NAME CLASH DETECTED ********** #{fileName}
+********* NAME CLASH DETECTED **********
+** This software has detected that a generated file
+** is being overwritten in the same code generation session.
+** This most likely is caused by a name clash in the source model.
+**
+** Filename being overwritten is
+** "#{fileName}"
+** Model Element being processed is:
+** #{mtk_object_message}
+**
+** Model element being processed is related to:
+** #{mtk_related_message}
+********* NAME CLASH DETECTED **********
+        }}
+    else
+      MTK_WRITE_SESSION_FILE_NAMES<< fileName.to_s
+    end
+  end
+
+  #writes before string,
+  #yield block and then writes after.
+  #
+  #EXAMPLE.
+  # encloseWrite("<title>","</title>") { write "Today news" }
+  def encloseWrite(beforeStr,afterStr,&middleBlock)
+    write(beforeStr.to_s)
+    yield
+    write(afterStr.to_s)
+  end
+
+  # Write string to the current file opened by mtk_writeSession.
+  def write(str)
+    if !@@mtk_out.nil?
+      @@mtk_out.write(str)
+      return
+    end
+    raise Warning.new(), <<END
+There is no file currently opened.
+Please use mtk_writeSession prior to using any write method.
+Example:
+#  mtk_writeSession('file1.java') {
+#    write("Package .... ;")
+#       }
+#  }
+END
+  end
+
+  # Internal use.
+  #
+  # Transforms a uri to a uri qualified by the current file name
+  def mtk_qualifyBlockURI(_uri)
+    return "#{_uri}__#{context[:mtk_fileName]}"
+  end
+
+  #def mtk_fileType
+  #	fileType=nil
+  #	puts "fileType1=#{fileType}"
+  #	fileType=context.get(:mtk_fileType)
+  #	puts "fileType2=#{fileType}"
+  #	fileType=FileType.get(fileName) if fileType.nil?
+  #	puts "fileType3=#{fileType}"
+  #
+  #	#fileType=FileTypeJava.instance
+  #	return fileType
+  #end
+
+  #
+  # Internal use.
+  #
+  # Reverse the file currently being written by mtk_writeSession.
+  # This method is automaticaly called
+  def mtk_retrieveProtected(fileName,fileType)
+    return false unless File.exists?(fileName)
+
+    mtk_context(:mtk_fileName=>fileName) {
+      File.open(fileName,'r') { |aFile|
+        i=0
+        reading=false
+        block_uri=nil
+        buffer=''
+        reverseMode=nil
+
+        aFile.each_line { |line|
+          i=i+1
+          if !reading
+            #return if !line.include?("PROTECTED REGION XMDA BEGIN") # optimisation ?
+            m=fileType.re_begin.match(line)
+            #log.debug {"beg match_ok=#{!m.nil?} line=#{line}"}
+            next if m.nil?
+            #raise Warning.new,"Error Reading Protected region header\n#{fileName}:line #{i}: #{line}" if m.nil?
+            reading=true
+            buffer=''
+            linesep=''
+            block_uri=fileType.unescape(m[2].to_s)
+            #log.debug { "ma: #{m[0]} block_uri=#{block_uri}" }
+            raise Warning.new,'Error Reading Protected region header nil uri' if block_uri.nil?
+            case m[1]
+            when 'yes' then reverseMode=true
+            when 'no'  then reverseMode=false
+            else raise Warning.new,%{Bad reverseMode value in file #{fileName}. reverse="yes" or reverse="no" expected (got "#{m[1]}" line ##{i}).}
+            end
+            raise Warning.new,'Error Reading Protected region header nil uri' if reverseMode.nil?
+            #log.debug { "!!!!!! block_ri=--#{block_uri}--" }
+          else
+            #log.debug "#{reading} line=#{line}"
+            m=fileType.re_end.match(line)
+            #log.debug "end match_ok=#{!m.nil?} line=#{line}"
+            if m.nil?
+              buffer=buffer.nil? ?  line : "#{buffer}#{line}"
+              next
+            end
+            block_uri_end=fileType.unescape(m[1].to_s)
+            if block_uri_end!=block_uri
+              raise WarningReverseBadOrMissingEnd.new, <<ENDERRORMSG
+Bad non matching END tag in  #{fileName}
+  expected uri="#{block_uri}"
+  and got  uri="#{block_uri_end}"
+  line ##{i})
+ENDERRORMSG
+            end
+            reading=false
+            #log.debug "block_uri=#{block_uri} protected ->xxxxxxx\n#{buffer}xxxxxxxxxx"
+            qualified_block_uri=mtk_qualifyBlockURI(block_uri)
+            if reverseMode
+              self[qualified_block_uri]=buffer[0,buffer.size-1]
+              open("reverse.log","a") {|r|
+                r.write("\n### reverse #{qualified_block_uri}\n")
+                r.write( "#{self[qualified_block_uri]} #{self[qualified_block_uri].length}")
+              } #unless context[:logFileReverse].nil?
+            else
+              #log.debug "Reverse ignored #{context[:mtk_fileName]}!"
+            end
+          end
+
+        }
+      }}
+    return true # un fichier a ete retro
+  end
+end
+
+#module Mrdf_Resource
+#end
+module Mmtk_helper #_Resource
+  REVERSE=true
+  NOREVERSE=false
+
+  # mtk_protected is used when generated code can be modified by user and preserved by subsequent generation.
+  # The code generated in the block passed as parameter will be generated encolosed between identifiable tags.
+  #
+  # NOTE:
+  #    The block is identified by the current rdf resource URI.
+  #    If more than one block is to be generated in one file, zoneId must be used.
+  #
+  #
+  #
+  #
+  #Example 1: default
+  #  mtk_writeSession('file1.java') {
+  #    write("Package .... ;")
+  #    a.mtk_protected() {
+  #       write("default code to be redefined by user");
+  #       }
+  #    b.mtk_protected() {
+  #       write("default code to be redefined by user");
+  #       }
+  #  }
+  #Example 2: initial mode is reverse
+  #  mtk_writeSession('file1.java') {
+  #    write("Package .... ;")
+  #    mtk_protected(REVERSE) {
+  #       write("default code to be redefined by user");
+  #       }
+  #  }
+  #Example 3: initial mode is noreverse
+  #  mtk_writeSession('file1.java') {
+  #    write("Package .... ;")
+  #    mtk_protected(NOREVERSE) {
+  #      write("default code to be redefined by user");
+  #      }
+  #  }
+  #Example 4: multiple-protected zone for a single object
+  #  mtk_writeSession('file1.java') {
+  #    write("Package .... ;")
+  #    a.mtk_protected(REVERSE,"a") {
+  #       write("default code to be redefined by user");
+  #       }
+  #    a.mtk_protected(REVERSE,"b") {
+  #       write("default code to be redefined by user");
+  #       }
+  #  }
+  def mtk_protected(initialReverseMode=false,zoneId='0',&block)
+    #mbu=mtk_block_uri
+    raise Exception.new("Bad parameter") if initialReverseMode!=false && initialReverseMode!=true
+    mbu="#{rdf_uri}__#{zoneId}"
+    qualified_uri=rdf_model.mtk_qualifyBlockURI(mbu)
+
+    fileType=context[:protectedReverse].fileType
+    str=context[:protectedReverse][qualified_uri]
+
+    reverse= (!str.nil?) || initialReverseMode
+
+    if (!reverse) && context[:skipNoReverseMarker,false]
+      write(fileType.beginMarkerSkip(mbu,reverse))
+    else
+      write(fileType.beginMarker(mbu,reverse))
+    end
+
+    if str.nil?
+      #log.debug "!!yield block_uri=#{mbu}"
+      yield
+    else
+      write(str)
+    end
+    if (!reverse) && context[:skipNoReverseMarker,false]
+      write(fileType.endMarkerSkip(mbu))
+    else
+      write(fileType.endMarker(mbu))
+    end
+  end
+
+  #Stream to String Session
+  def mtk_stss(&block)
+    #@rdf_model.mtk_stringWriteSession(&block)
+    mtk_stringWriteSession(&block)
+  end
+
+  #internal method.
+  #
+  #Returns file descriptor currently used by mtk_writeSession.
+  def mtk_out
+    return context[:mtk_out]
+  end
+
+end
+
+#Internal use.
+#
+#Used by mtk_stringWriteSession.
+class StringOutputStream
+  def initialize
+    @str=nil
+  end
+
+  # Internal use.
+  #
+  # Simulates file open
+  def open ; end
+
+  # Internal use.
+  #
+  # Simulates file open
+  def close ; end
+
+  # Internal use.
+  #
+  # Appends str to internal steam buffer
+  def write (str)
+    #log.debug "Ajout #{str.to_s} !!"
+    if @str
+      @str="#{@str}#{str.to_s}"
+    else
+      @str=str.to_s
+    end
+  end
+
+  # Internal use.
+  # returns the internal stream buffer
+  def to_s
+    return @str
+  end
+end
+
+
+
+module Mcore_Product
+end
+
+class Ccore_Product < Crdfs_Class
+  include Mcore_Product
+  def generate
+  end
+
+end
+
+# a file writer that writes nowhere
+class NullFileWriter
+  include Singleton
+  def write(str)
+    # does nothing !
+  end
+end
+